-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add flamegraph to en_US-grafana.wordlist #575
Conversation
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think flamegraph is jargon and is typically written as one word. However, the author of the flamegraph, Brendan Gregg, writes it in two words: https://www.brendangregg.com/flamegraphs.html
This is a really interesting one because the existing suffix rule would expect "flamegraphes" because anything ending with an "h" is suffixed with "es" https://github.com/grafana/writers-toolkit/pull/575/files#diff-a866c302e6905a20dcba419725819c9f4a1d02502f1b782971825bff55483dceL23.
I've added an additional case for "ph" -> "phs". Let me know if you know of a significant number of exceptions to that rule.
I asked about whether this is one word or two words in the Pyroscope dev channel. The response was the same as you mentioned above: we consistently use it as one word but the original author uses it as two. The earliest content on Pyroscope.io uses flamegraph as one word as well. However, to be consistent with all of the UI and existing doc for Pyroscope, I'd vote for keeping flamegraph as one word. We can always revisit it later.
That is interesting. Maybe it isn't the singular "h" but the grouping of letters with the "H". The word "graphes" looks wrong to me, while "graphs" looks correct. Although, not everything ending in an "h" uses "es" as a suffix. For example, words ending in "-th" add an s (month > months), while words ending in -sh or -ch add an -es (marsh > marshes). See https://en.wikipedia.org/wiki/English_plurals#Irregular_plurals for some additional examples.
This would be an excellent question for the style roundtable discussion, honestly. I know there are others besides gh, ph, th, sh, ch. We'll need to dig out some heavy style guides and grammar rules to find all of the answers. |
❤️ great analysis. I think this suffix rule should be fine for now but I'll definitely bring the topic up if it will get people interested :) |
That seems... wrong. It should be anything ending in |
Added flamegraph to the word list for Vale.
Flamegraph is listed as one word, which is consistent with all of the documentation for Pyroscope.