On Wed, Jun 16 2021, Junio C Hamano wrote:
> Junio C Hamano <gitster@xxxxxxxxx> writes:
>
>> FWIW, I am not happy with this version for that reason, either.
>>
>> I wonder if replacing the first two bullet points ("Removing" and
>> "If you need to talk about") above with what was added to the
>> CodingGuidelines by the "succinct matter-of-factly description" in
>>
>> https://lore.kernel.org/git/87a6nz2fda.fsf@xxxxxxxxxxxxxxxxxxx/
>>
>> would be sufficient.
>
> So, here is what I plan to queue on top of these four patches to
> replace my "not even draft" garbage with what you wrote, with a bit
> of copyediting.
>
> Comments?
>
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 605f924981..476b840d30 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -546,28 +546,43 @@ Writing Documentation:
> twice before using "he", "him", "she", or "her". Here are some
> tips to avoid use of gendered pronouns:
>
> - - Removing the example person might make the sentence more
> - clear and efficient. Instead of saying "The programmer
> - chooses between X and Y as she sees fit", it is clearer to
> - say "Valid choices are X and Y".
> -
> - - If you need to talk about an example person, then try using
> - second-person to allow the reader to be that example. For
> - example, "If you want X to happen, you'd pass option Y",
> - instead of "If the user wants X to happen, she'd ...").
> - Alternatively, replace the single example with more than one
> - person and use plural "they", such as "Interested readers
> - can read 'git log -p README' to learn the history in their
> - ample spare time" instead of "an interested reader" learning
> - in "his" spare time).
> -
> - - If you absolutely need to refer to an example person that is
> - third-person singluar, you may resort to "singular they" (e.g.
> - "A contributor asks their upstream to pull from them"). Note
> - that this sounds ungrammatical and unnatural to those who
> - learned English as a second language in some parts of the
> - world, so should be avoided unless the earlier techniques
> - fail to improve the sentence.
> + - Prefer succinctness and matter-of-factly describing functionality
> + in the abstract. E.g.
> +
> + --short:: Emit output in the short-format.
> +
> + and avoid something like these overly verbose alternatives:
> +
> + --short:: Use this to emit output in the short-format.
> + --short:: You can use this to get output in the short-format.
> + --short:: A user who prefers shorter output could....
> + --short:: Should a person and/or program want shorter output, he
> + she/they/it can...
> +
> + This practice often eliminates the need to involve human actors in
> + your description, but it is a good practice regardless of the
> + avoidance of gendered pronouns.
> +
> + - When it becomes awkward to stick to this style, prefer "you" when
> + addressing the the hypothetical user, and possibly "we" when
> + discussing how the program might react to the user. E.g.
> +
> + You can use this option instead of --xyz, but we might remove
> + support for it in future versions.
> +
> + while keeping in mind that you can probably be less verbose, e.g.
> +
> + Use this instead of --xyz. This option might be removed in future
> + versions.
> +
> + - If you still need to refer to an example person that is
> + third-person singular, you may resort to "singular they" to avoid
> + "he/she/him/her", e.g.
> +
> + A contributor asks their upstream to pull from them.
> +
> + Note that this sounds ungrammatical and unnatural to those who
> + learned English as a second language in some parts of the world.
>
> Every user-visible change should be reflected in the documentation.
> The same general rule as for code applies -- imitate the existing
That mostly-my-draft was hastily a written one-off, perhaps this is
better and a more exhaustive discussion of common cases:
- Discussing command-line options, and program functionality:
Prefer succinctness and matter-of-factly describing functionality in
the abstract. E.g.
--short:: Emit output in the short-format.
Avoid more verbose constructions, such as:
--short:: Use this to emit output in the short-format.
--short:: You can use this to get output in the short-format.
--short:: A user who prefers shorter output could....
--short:: Should a person and/or program want shorter output, he
she/they/it can...
- Addressing the reader:
Address the reader of the documentation directly with "you",
e.g. "you can do xyz".
- Discussing Git, "the command" etc.:
Use "we" when discussing how the program might react to the user, or
perhaps "git" or "the command", e.g.:
we might store the data[...]
git will emit[...]
the command will[...]
- Discussing other users:
When referring to other users on the same system prefer talking
about "a user" or "another user". There's usually no reason to
invent a cast of characters with names, titles and hobbies.
Your OS's users don't cleanly map onto any particular people, a user
of git might be having a merge conflict with another person, or an
automated commit from a cron daemon.
We prefer the style typical of standard library adn system tooling
documentation in this and most other cases, you can look at the
documentation of chmod(2) and other commands, syscalls and libraries
that deal with UIDs or GIDs for examples.
- Discussing other systems:
As with discussing other users, git might interact with other
systems over the network. In these cases we also avoid a cast of
characters, preferring to talk about concepts like "fetching data
from a remote", having a conflict with "diverging histories" etc.
The references to "gendered prounouns" etc. are gone, perhaps there's a
good reason to re-include them, but the point of "isn't that issue
solved by recommending an orthagonal approach?" is one of the many
things Stolee hasn't been addressing in the threads related to this
series.
To me that whole approach is somewhere between a solution in search of a
problem and a "let's fix it and move on". Not something we need
explicitly carry in our CodingGuidelines forever.
The v1 of this series started with decreeing that nobody should be using
gendered language in commit messages. It seems that the discussion I
started that perhaps that was overly pedantic and unfriendly to people
struggling with English won out, so that's gone in recent revisions.
That's left only a handful of examples \b(?:she|he)\b in our docs, we
have outstanding patches to fix those, and draft guidelines (amended
above) to thoroughly lead documentation writers in other directions.
It just seems superfluous to me to insist on enumerating increasingly
obscure and disfavored alternatives to what we suggest as preferred
prose in our documentation. For example, we have around the same order
of magnitude of "one might" in Documentation/, I think we should
probably just fix that and move on, not forever have a guideline against
overly formal or "Shakespearean language" in the guidelines.
