Re: [Mesa-dev] docs: consistent language
On Fri, 2021-03-26 at 18:22 +0100, Erik Faye-Lund wrote: > On Mon, 2021-03-15 at 13:44 +0100, Erik Faye-Lund wrote: > > TLDR; I'm proposing to standardize on US English in our public- > > facing > > documentation. > > > > I proposed an MR a while back that changed the only occurrence of > > the > > UK English spelling "optimisation" for the US English spelling > > "optimization", which is already used 34 times in the docs. I've > > done > > similar changes in the past. > > > > But this time Ian brought up the good point that picking a > > preferred > > language should probably be done using group consensus on the > > mailing > > list than just picking what's currently most popular. > > > > So, I hereby propose to pick US English as our default language for > > user-facing documentation. > > > > I'm not proposing to force anyone to use a particular English > > variant > > for things like comments, commit messages or variable names. I > > don't > > think there's much value in enforcing that, and I think it'd be > > perfectly fine if any particular driver wanted to pick a particular > > variant of English. > > > > The main reason I want to standardize on an English variant is that > > I'm > > trying create a word-list for domain-specific/technical language to > > detect spelling mistakes in the docs more easily. And not having to > > add > > both US and UK English words makes this list easier to maintain. > > I'm > > not planning on going 100% systematically though the dictionary to > > detect UK English words that might be in my system dictionary, just > > to > > fix the words that currently cause me (a tiny amount of) pain ;) > > > > The main reason why I'm proposing US English over for instance UK > > English is that this seems to be the dominant variant currently in > > the > > documentation. So it seems like the pragmatic choice to me. > > > > Thoughts? Any objections to sticking to US English in the docs? > > OK, so almost two weeks has passed, and I've only gotten a single > objection to the proposal, but a handfull of variations of voices in > favor of the proposal. > > I suspect this is as close to a consensus we're going to reach. Since > it's not 100% consensus, I think maybe the best option is to take > Kenneth Grauke's suggestion of making this a recommendation rather > than > a rule. > > So my plan is to write up a patch for the docs that explains that we > recommend writing docs in US English. That should IMO make it clear > that we don't require people to spell-check to make sure that they're > using the "right" variation of English. At the same time, it's clear > enough that we're happy about patches moving towards US English. I've had the MR up here for a few weeks, but it hasn't gotten any r-b or a-b tags yet: https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/9912 Anyone interested in reviewing it? ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On Mon, 2021-03-15 at 13:44 +0100, Erik Faye-Lund wrote: > TLDR; I'm proposing to standardize on US English in our public-facing > documentation. > > I proposed an MR a while back that changed the only occurrence of the > UK English spelling "optimisation" for the US English spelling > "optimization", which is already used 34 times in the docs. I've done > similar changes in the past. > > But this time Ian brought up the good point that picking a preferred > language should probably be done using group consensus on the mailing > list than just picking what's currently most popular. > > So, I hereby propose to pick US English as our default language for > user-facing documentation. > > I'm not proposing to force anyone to use a particular English variant > for things like comments, commit messages or variable names. I don't > think there's much value in enforcing that, and I think it'd be > perfectly fine if any particular driver wanted to pick a particular > variant of English. > > The main reason I want to standardize on an English variant is that > I'm > trying create a word-list for domain-specific/technical language to > detect spelling mistakes in the docs more easily. And not having to > add > both US and UK English words makes this list easier to maintain. I'm > not planning on going 100% systematically though the dictionary to > detect UK English words that might be in my system dictionary, just > to > fix the words that currently cause me (a tiny amount of) pain ;) > > The main reason why I'm proposing US English over for instance UK > English is that this seems to be the dominant variant currently in > the > documentation. So it seems like the pragmatic choice to me. > > Thoughts? Any objections to sticking to US English in the docs? OK, so almost two weeks has passed, and I've only gotten a single objection to the proposal, but a handfull of variations of voices in favor of the proposal. I suspect this is as close to a consensus we're going to reach. Since it's not 100% consensus, I think maybe the best option is to take Kenneth Grauke's suggestion of making this a recommendation rather than a rule. So my plan is to write up a patch for the docs that explains that we recommend writing docs in US English. That should IMO make it clear that we don't require people to spell-check to make sure that they're using the "right" variation of English. At the same time, it's clear enough that we're happy about patches moving towards US English. It seems we're missing docs on how to write docs anyway (I guess that's meta-docs?), so I guess this is a good time to add this. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
+1 to recommending the use of US English spelling in Mesa docs & code. I certainly would not want to impose any heavy burdens on contributors who are accustomed to UK/AU spelling. I don't think we should block any patches because of UK/US/AU spelling, and people should feel free to not think about it and use their normal language when contributing. Consistency can be nice when searching for code. The main reason I like fixing typos and pure misspellings (wrong in all dialects) in our code is to improve searchability. It's usually no trouble to read a sentence with some typos. But try searching for a function or enum where the name has a typo, and you likely won't find it, and then have to waste time digging through the code until you finally find it. US/UK/AU spelling variations usually haven't come up in that regard, though I did notice that midgard and llvmpipe are using "optimise" (16 uses) in some functions, while optimize (1087 uses) is more common. One awkward bit is that Gallium hooks like pipe->finalize_nir() already impose a US spelling. Having the driver set pipe->finalize_nir = driver_finalise_nir seems a bit awkward. On the other hand, using both finalize_nir (US spelling to match the hook) and optimise_nir (UK spelling because there's no hook to match) becomes internally inconsistent...so maybe it's better to just pick one. Having a policy of preferring US spelling seems nice, as we could auto-ack any patches to make the docs and code consistent, like we already do for typo fixes and pure spelling or grammatical fixes. That way we remove the need for debate on each encounter, while also not blocking people's work and contributions over trivial matters. --Ken On Tuesday, March 16, 2021 5:19:43 AM PDT Erik Faye-Lund wrote: > Just one detail to fill in: > > I just got a question on #dri-devel if this suggestion would place an > additional burden on most developers to additionally look up every word > of new documentation to see if it's US or UK English. > > I'm not proposing to place any additional burden on people writing > docs. I think it's fine if people do a best-effort (which arguably can > be low; this isn't a very important detail), and then we'll either > catch things during reviews or fix it up afterwards. > > It's not like the Mesa docs are perfect in terms of spelling or grammar > anyway, I just want to resolve which of the forks in the road we follow > trying to clean things up ;) > > On Mon, 2021-03-15 at 13:44 +0100, Erik Faye-Lund wrote: > > TLDR; I'm proposing to standardize on US English in our public-facing > > documentation. > > > > I proposed an MR a while back that changed the only occurrence of the > > UK English spelling "optimisation" for the US English spelling > > "optimization", which is already used 34 times in the docs. I've done > > similar changes in the past. > > > > But this time Ian brought up the good point that picking a preferred > > language should probably be done using group consensus on the mailing > > list than just picking what's currently most popular. > > > > So, I hereby propose to pick US English as our default language for > > user-facing documentation. > > > > I'm not proposing to force anyone to use a particular English variant > > for things like comments, commit messages or variable names. I don't > > think there's much value in enforcing that, and I think it'd be > > perfectly fine if any particular driver wanted to pick a particular > > variant of English. > > > > The main reason I want to standardize on an English variant is that > > I'm > > trying create a word-list for domain-specific/technical language to > > detect spelling mistakes in the docs more easily. And not having to > > add > > both US and UK English words makes this list easier to maintain. I'm > > not planning on going 100% systematically though the dictionary to > > detect UK English words that might be in my system dictionary, just > > to > > fix the words that currently cause me (a tiny amount of) pain ;) > > > > The main reason why I'm proposing US English over for instance UK > > English is that this seems to be the dominant variant currently in > > the > > documentation. So it seems like the pragmatic choice to me. > > > > Thoughts? Any objections to sticking to US English in the docs? > > > > The MR in question: > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572 > > > > Ian's response: > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572#note_808593 > > > > Previous changes: > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6864 > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6894 > > > > > > ___ > > mesa-dev mailing list > > mesa-dev@lists.freedesktop.org > > https://lists.freedesktop.org/mailman/listinfo/mesa-dev > > > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org >
Re: [Mesa-dev] docs: consistent language
On Mon, 2021-03-15 at 10:54 -0700, Ian Romanick wrote: > > If anyone doesn't feel comfortable speaking out publicly about this, > please feel free to contact Erik or me privately. Just thought I'd mention; I've gotten a vote against the proposal through other channels. Because I haven't gotten explicit permission to name the person, I'm not doing so here. The person said it's not a hill they're willing to die on, though. But it's worth mentioning. My understanding is that the vote against is a vote to effectively leave the english variant undefined, similar to what Wikipedia does. So not really a vote for some other specific variant of English. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
>Absolutely. Apparently I forgot to write the final line which is that I >think standardising on US English across the board is a good thing Standardise on any flavour of English you'd like, one of them is still wrong ;-) ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
Hi, On Mon, Mar 15, 2021 at 01:44:18PM +0100, Erik Faye-Lund wrote: > The main reason I want to standardize on an English variant is that I'm > trying create a word-list for domain-specific/technical language to > detect spelling mistakes in the docs more easily. Are you aware of codespell[1]? It already contains a list of common spelling mistakes, and supports an exclusion list for domain-specific words we want to keep, for instance we don’t want to “fix” LOD → LOAD so we can write LOD in a file and pass --ignore-words=that-file when running it in CI. [1] https://pypi.org/project/codespell/ -- Emmanuel Gil Peyrot signature.asc Description: PGP signature ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On Tue, 16 Mar 2021 at 13:08, Jason Ekstrand wrote: > On March 16, 2021 05:06:53 Daniel Stone wrote: > >> On Mon, 15 Mar 2021 at 20:54, Jason Ekstrand >> wrote: >> >>> Three comments: >>> >>> 1. +1 >>> 2. Khronos has generally standardized on American English in their >>> specs so I guess that provides some sort of prior art or something. >>> 3. I'd generally be a fan of encouraging American spellings in common >>> code as well. As someone who doesn't use auto-complete, having to >>> remember which variable is named "color" and which is "colour" would >>> get painful. Fortunately, we don't have a whole lot of variation here >>> but it'd be good to keep consistency. >> >> >> 4. UK English is unarguably correct and better. >> > > > > 5. That doesn't change point #3 in particular; just like coding style, one >> 'bad' choice is better than no choice at all. >> > > I have three words for you: three space tabs. Yeah... It may be a good > style but consistency is good. 浪 > Absolutely. Apparently I forgot to write the final line which is that I think standardising on US English across the board is a good thing, even though I personally like it about as much as three-space tabs. As you can see from the previous sentence. ;) So, +1 from me too. Cheers, Daniel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On March 16, 2021 05:06:53 Daniel Stone wrote: On Mon, 15 Mar 2021 at 20:54, Jason Ekstrand wrote: Three comments: 1. +1 2. Khronos has generally standardized on American English in their specs so I guess that provides some sort of prior art or something. 3. I'd generally be a fan of encouraging American spellings in common code as well. As someone who doesn't use auto-complete, having to remember which variable is named "color" and which is "colour" would get painful. Fortunately, we don't have a whole lot of variation here but it'd be good to keep consistency. 4. UK English is unarguably correct and better. 5. That doesn't change point #3 in particular; just like coding style, one 'bad' choice is better than no choice at all. I have three words for you: three space tabs. Yeah... It may be a good style but consistency is good. 浪 --Jason ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
Just one detail to fill in: I just got a question on #dri-devel if this suggestion would place an additional burden on most developers to additionally look up every word of new documentation to see if it's US or UK English. I'm not proposing to place any additional burden on people writing docs. I think it's fine if people do a best-effort (which arguably can be low; this isn't a very important detail), and then we'll either catch things during reviews or fix it up afterwards. It's not like the Mesa docs are perfect in terms of spelling or grammar anyway, I just want to resolve which of the forks in the road we follow trying to clean things up ;) On Mon, 2021-03-15 at 13:44 +0100, Erik Faye-Lund wrote: > TLDR; I'm proposing to standardize on US English in our public-facing > documentation. > > I proposed an MR a while back that changed the only occurrence of the > UK English spelling "optimisation" for the US English spelling > "optimization", which is already used 34 times in the docs. I've done > similar changes in the past. > > But this time Ian brought up the good point that picking a preferred > language should probably be done using group consensus on the mailing > list than just picking what's currently most popular. > > So, I hereby propose to pick US English as our default language for > user-facing documentation. > > I'm not proposing to force anyone to use a particular English variant > for things like comments, commit messages or variable names. I don't > think there's much value in enforcing that, and I think it'd be > perfectly fine if any particular driver wanted to pick a particular > variant of English. > > The main reason I want to standardize on an English variant is that > I'm > trying create a word-list for domain-specific/technical language to > detect spelling mistakes in the docs more easily. And not having to > add > both US and UK English words makes this list easier to maintain. I'm > not planning on going 100% systematically though the dictionary to > detect UK English words that might be in my system dictionary, just > to > fix the words that currently cause me (a tiny amount of) pain ;) > > The main reason why I'm proposing US English over for instance UK > English is that this seems to be the dominant variant currently in > the > documentation. So it seems like the pragmatic choice to me. > > Thoughts? Any objections to sticking to US English in the docs? > > The MR in question: > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572 > > Ian's response: > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572#note_808593 > > Previous changes: > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6864 > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6894 > > > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On Tue, 2021-03-16 at 10:06 +, Daniel Stone wrote: > On Mon, 15 Mar 2021 at 20:54, Jason Ekstrand > wrote: > > Three comments: > > > > 1. +1 > > 2. Khronos has generally standardized on American English in their > > specs so I guess that provides some sort of prior art or something. > > 3. I'd generally be a fan of encouraging American spellings in > > common > > code as well. As someone who doesn't use auto-complete, having to > > remember which variable is named "color" and which is "colour" > > would > > get painful. Fortunately, we don't have a whole lot of variation > > here > > but it'd be good to keep consistency. > > > > 4. UK English is unarguably correct and better. Actually, strike all of the above, and let's write all docs in Norwegian Bokmål instead. Or even better, Esperanto! > 5. That doesn't change point #3 in particular; just like coding > style, one 'bad' choice is better than no choice at all. Yeah, so I don't oppose consistent language in code and comments either, but I suspect that's a bit harder to change or get agreement on. For instance, it seems both Panfrost and Nouveau use quite a bit of UK English, whereas AFAICT most other drivers use mostly US English (mostly based on grepping for "color" vs "colour", so a very flawed metric indeed, but whatever). I simply don't want to hold back a decision about the docs due to something that might be harder to agree about. Color me self-serving here, I guess ;) ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On Mon, 15 Mar 2021 at 20:54, Jason Ekstrand wrote: > Three comments: > > 1. +1 > 2. Khronos has generally standardized on American English in their > specs so I guess that provides some sort of prior art or something. > 3. I'd generally be a fan of encouraging American spellings in common > code as well. As someone who doesn't use auto-complete, having to > remember which variable is named "color" and which is "colour" would > get painful. Fortunately, we don't have a whole lot of variation here > but it'd be good to keep consistency. 4. UK English is unarguably correct and better. 5. That doesn't change point #3 in particular; just like coding style, one 'bad' choice is better than no choice at all. Cheers, Daniel ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On Mon, 2021-03-15 at 13:44 +0100, Erik Faye-Lund wrote: > TLDR; I'm proposing to standardize on US English in our public-facing > documentation. +1 J.A. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On Mon, 15 Mar 2021 at 22:44, Erik Faye-Lund wrote: > > TLDR; I'm proposing to standardize on US English in our public-facing > documentation. > > I proposed an MR a while back that changed the only occurrence of the > UK English spelling "optimisation" for the US English spelling > "optimization", which is already used 34 times in the docs. I've done > similar changes in the past. > > But this time Ian brought up the good point that picking a preferred > language should probably be done using group consensus on the mailing > list than just picking what's currently most popular. > > So, I hereby propose to pick US English as our default language for > user-facing documentation. > > I'm not proposing to force anyone to use a particular English variant > for things like comments, commit messages or variable names. I don't > think there's much value in enforcing that, and I think it'd be > perfectly fine if any particular driver wanted to pick a particular > variant of English. > > The main reason I want to standardize on an English variant is that I'm > trying create a word-list for domain-specific/technical language to > detect spelling mistakes in the docs more easily. And not having to add > both US and UK English words makes this list easier to maintain. I'm > not planning on going 100% systematically though the dictionary to > detect UK English words that might be in my system dictionary, just to > fix the words that currently cause me (a tiny amount of) pain ;) > > The main reason why I'm proposing US English over for instance UK > English is that this seems to be the dominant variant currently in the > documentation. So it seems like the pragmatic choice to me. > > Thoughts? Any objections to sticking to US English in the docs? All good, though I'm in the most likely to screw this up category, I'm never sure when to use s or z so it usually ends up being rather random, I think I've mostly got my outbreaks of colour under control. Dave. ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
+1 to all of this. On Mon, Mar 15, 2021 at 1:54 PM Jason Ekstrand wrote: > > Three comments: > > 1. +1 > 2. Khronos has generally standardized on American English in their > specs so I guess that provides some sort of prior art or something. > 3. I'd generally be a fan of encouraging American spellings in common > code as well. As someone who doesn't use auto-complete, having to > remember which variable is named "color" and which is "colour" would > get painful. Fortunately, we don't have a whole lot of variation here > but it'd be good to keep consistency. > > --Jason > > On Mon, Mar 15, 2021 at 12:59 PM Ian Romanick wrote: > > > > On 3/15/21 5:44 AM, Erik Faye-Lund wrote: > > > TLDR; I'm proposing to standardize on US English in our public-facing > > > documentation. > > > > > > I proposed an MR a while back that changed the only occurrence of the > > > UK English spelling "optimisation" for the US English spelling > > > "optimization", which is already used 34 times in the docs. I've done > > > similar changes in the past. > > > > > > But this time Ian brought up the good point that picking a preferred > > > language should probably be done using group consensus on the mailing > > > list than just picking what's currently most popular. > > > > Over the years we've had quite a few contributions from folks in many > > different English spelling parts of the world where the UK spelling is > > the norm... though I don't think there have been that many from the UK > > itself. :) I suggested getting some group consensus because I didn't > > want any of those people to feel left out or undervalued. > > > > If anyone doesn't feel comfortable speaking out publicly about this, > > please feel free to contact Erik or me privately. > > > > > So, I hereby propose to pick US English as our default language for > > > user-facing documentation. > > > > > > I'm not proposing to force anyone to use a particular English variant > > > for things like comments, commit messages or variable names. I don't > > > think there's much value in enforcing that, and I think it'd be > > > perfectly fine if any particular driver wanted to pick a particular > > > variant of English. > > > > > > The main reason I want to standardize on an English variant is that I'm > > > trying create a word-list for domain-specific/technical language to > > > detect spelling mistakes in the docs more easily. And not having to add > > > both US and UK English words makes this list easier to maintain. I'm > > > not planning on going 100% systematically though the dictionary to > > > detect UK English words that might be in my system dictionary, just to > > > fix the words that currently cause me (a tiny amount of) pain ;) > > > > > > The main reason why I'm proposing US English over for instance UK > > > English is that this seems to be the dominant variant currently in the > > > documentation. So it seems like the pragmatic choice to me. > > > > > > Thoughts? Any objections to sticking to US English in the docs? > > > > > > The MR in question: > > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572 > > > > > > Ian's response: > > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572#note_808593 > > > > > > Previous changes: > > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6864 > > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6894 > > > > > > > > > ___ > > > mesa-dev mailing list > > > mesa-dev@lists.freedesktop.org > > > https://lists.freedesktop.org/mailman/listinfo/mesa-dev > > ___ > > mesa-dev mailing list > > mesa-dev@lists.freedesktop.org > > https://lists.freedesktop.org/mailman/listinfo/mesa-dev > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
Three comments: 1. +1 2. Khronos has generally standardized on American English in their specs so I guess that provides some sort of prior art or something. 3. I'd generally be a fan of encouraging American spellings in common code as well. As someone who doesn't use auto-complete, having to remember which variable is named "color" and which is "colour" would get painful. Fortunately, we don't have a whole lot of variation here but it'd be good to keep consistency. --Jason On Mon, Mar 15, 2021 at 12:59 PM Ian Romanick wrote: > > On 3/15/21 5:44 AM, Erik Faye-Lund wrote: > > TLDR; I'm proposing to standardize on US English in our public-facing > > documentation. > > > > I proposed an MR a while back that changed the only occurrence of the > > UK English spelling "optimisation" for the US English spelling > > "optimization", which is already used 34 times in the docs. I've done > > similar changes in the past. > > > > But this time Ian brought up the good point that picking a preferred > > language should probably be done using group consensus on the mailing > > list than just picking what's currently most popular. > > Over the years we've had quite a few contributions from folks in many > different English spelling parts of the world where the UK spelling is > the norm... though I don't think there have been that many from the UK > itself. :) I suggested getting some group consensus because I didn't > want any of those people to feel left out or undervalued. > > If anyone doesn't feel comfortable speaking out publicly about this, > please feel free to contact Erik or me privately. > > > So, I hereby propose to pick US English as our default language for > > user-facing documentation. > > > > I'm not proposing to force anyone to use a particular English variant > > for things like comments, commit messages or variable names. I don't > > think there's much value in enforcing that, and I think it'd be > > perfectly fine if any particular driver wanted to pick a particular > > variant of English. > > > > The main reason I want to standardize on an English variant is that I'm > > trying create a word-list for domain-specific/technical language to > > detect spelling mistakes in the docs more easily. And not having to add > > both US and UK English words makes this list easier to maintain. I'm > > not planning on going 100% systematically though the dictionary to > > detect UK English words that might be in my system dictionary, just to > > fix the words that currently cause me (a tiny amount of) pain ;) > > > > The main reason why I'm proposing US English over for instance UK > > English is that this seems to be the dominant variant currently in the > > documentation. So it seems like the pragmatic choice to me. > > > > Thoughts? Any objections to sticking to US English in the docs? > > > > The MR in question: > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572 > > > > Ian's response: > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572#note_808593 > > > > Previous changes: > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6864 > > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6894 > > > > > > ___ > > mesa-dev mailing list > > mesa-dev@lists.freedesktop.org > > https://lists.freedesktop.org/mailman/listinfo/mesa-dev > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
Re: [Mesa-dev] docs: consistent language
On 3/15/21 5:44 AM, Erik Faye-Lund wrote: > TLDR; I'm proposing to standardize on US English in our public-facing > documentation. > > I proposed an MR a while back that changed the only occurrence of the > UK English spelling "optimisation" for the US English spelling > "optimization", which is already used 34 times in the docs. I've done > similar changes in the past. > > But this time Ian brought up the good point that picking a preferred > language should probably be done using group consensus on the mailing > list than just picking what's currently most popular. Over the years we've had quite a few contributions from folks in many different English spelling parts of the world where the UK spelling is the norm... though I don't think there have been that many from the UK itself. :) I suggested getting some group consensus because I didn't want any of those people to feel left out or undervalued. If anyone doesn't feel comfortable speaking out publicly about this, please feel free to contact Erik or me privately. > So, I hereby propose to pick US English as our default language for > user-facing documentation. > > I'm not proposing to force anyone to use a particular English variant > for things like comments, commit messages or variable names. I don't > think there's much value in enforcing that, and I think it'd be > perfectly fine if any particular driver wanted to pick a particular > variant of English. > > The main reason I want to standardize on an English variant is that I'm > trying create a word-list for domain-specific/technical language to > detect spelling mistakes in the docs more easily. And not having to add > both US and UK English words makes this list easier to maintain. I'm > not planning on going 100% systematically though the dictionary to > detect UK English words that might be in my system dictionary, just to > fix the words that currently cause me (a tiny amount of) pain ;) > > The main reason why I'm proposing US English over for instance UK > English is that this seems to be the dominant variant currently in the > documentation. So it seems like the pragmatic choice to me. > > Thoughts? Any objections to sticking to US English in the docs? > > The MR in question: > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572 > > Ian's response: > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572#note_808593 > > Previous changes: > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6864 > https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6894 > > > ___ > mesa-dev mailing list > mesa-dev@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/mesa-dev ___ mesa-dev mailing list mesa-dev@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/mesa-dev
