Re: [PATCH 4/4] CodingGuidelines: recommend singular they
- From
Derrick Stolee <stolee@gmail.com>
- Date
- Jun 9, 2021, 13:27 UTC
- Message-ID
- <a7419df4-38f3-70aa-ccae-12b42a80e422@gmail.com>
- In-Reply-To
- <xmqqa6nzlk8y.fsf@gitster.g>
On 6/9/2021 12:44 AM, Junio C Hamano wrote:
> Emily Shaffer <emilyshaffer@google.com> writes: > >> On Mon, Jun 07, 2021 at 04:57:48PM +0000, Derrick Stolee via GitGitGadget wrote:
...
Show 13 quoted lines
>>> + >>> + When referring to an anonymous user, use singular "they/them" pronouns >>> + as opposed to choosing between "he/him" and "she/her". Do not use more >>> + complicated constructs such as "he or she" or "s/he". This recommendation >>> + also applies to code comments and commit messages. > > I am not sure if this "here is the rule and you will follow it" is > helpful without hinting what the rule is trying to achieve. It is > more so that the four-bullet-point list in the proposed log message > that says when not to blindly apply the singular they rule will not > be seen by intended readers---we who are reviewing this change in > the patch form may understand and embrace it, but the readers have > less than we have to go with.
I went to far trying to be brief in CodingGuidelines in favor of a long commit message (that can be blamed). But you're right. "Start with why" is a good strategy.
Show 10 quoted lines
> Perhaps start the whole paragraph a bit differently, like this? > > Refer to an anonymous user in a gender neutral way. Use > singular "they/them" pronouns as opposed to ... > > The added single phase will be a sufficient clue to readers that > this is about inclusion, and will tell readers that singular they is > not a hard and fast rule but one of the suggested ways to achieve > that goal. To be even clearer, we may probably want to add "One way > to do so is to" before the second sentence.
That's a good idea.
The other thing I have added is to recommend changing the sentence to use different nouns so that singular "you" or plural "they" are appropriate.
Thanks, -Stolee