From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, sandals@crustytoothpaste.net,
stolee@gmail.com, jrnieder@gmail.com, emilyshaffer@google.com,
Andrei Rybak <rybak.a.v@gmail.com>,
Felipe Contreras <felipe.contreras@gmail.com>,
Robert Karszniewicz <avoidr@posteo.de>, Jeff King <peff@peff.net>,
"Kerry, Richard" <richard.kerry@atos.net>,
Phillip Susi <phill@thesusis.net>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Derrick Stolee <derrickstolee@github.com>,
Derrick Stolee <dstolee@microsoft.com>
Subject: Re: [PATCH v3 4/4] CodingGuidelines: recommend singular they
Date: Wed, 16 Jun 2021 14:06:32 +0900 [thread overview]
Message-ID: <xmqqbl86qtyf.fsf@gitster.g> (raw)
In-Reply-To: <xmqqsg1iseza.fsf@gitster.g> (Junio C. Hamano's message of "Wed, 16 Jun 2021 11:47:05 +0900")
Junio C Hamano <gitster@pobox.com> 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@evledraar.gmail.com/
>
> 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
--
2.32.0-241-g31cd86ad06
next prev parent reply other threads:[~2021-06-16 5:07 UTC|newest]
Thread overview: 124+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-07 16:57 [PATCH 0/4] Use singular "they" when appropriate Derrick Stolee via GitGitGadget
2021-06-07 16:57 ` [PATCH 1/4] Documentation: use singular they " Derrick Stolee via GitGitGadget
2021-06-07 17:09 ` Ævar Arnfjörð Bjarmason
2021-06-07 17:32 ` Derrick Stolee
2021-06-07 17:42 ` Andrei Rybak
2021-06-07 18:21 ` Ævar Arnfjörð Bjarmason
2021-06-10 7:44 ` Johannes Schindelin
2021-06-10 14:35 ` Felipe Contreras
2021-06-07 21:36 ` Felipe Contreras
2021-06-09 18:47 ` Phillip Susi
2021-06-09 20:26 ` Felipe Contreras
2021-06-11 15:40 ` Phillip Susi
2021-06-11 17:03 ` Felipe Contreras
2021-06-10 18:30 ` Derrick Stolee
2021-06-11 0:16 ` Junio C Hamano
2021-06-11 16:00 ` Felipe Contreras
2021-06-12 14:02 ` Phillip Susi
2021-06-08 1:18 ` Junio C Hamano
2021-06-08 8:51 ` Kerry, Richard
2021-06-08 23:21 ` Junio C Hamano
2021-06-09 13:13 ` Derrick Stolee
2021-06-10 3:11 ` Junio C Hamano
2021-06-08 17:33 ` Emily Shaffer
2021-06-08 18:03 ` Felipe Contreras
2021-06-09 13:44 ` Kerry, Richard
2021-06-09 17:44 ` Felipe Contreras
2021-06-25 14:30 ` Kerry, Richard
2021-06-09 4:48 ` Junio C Hamano
2021-06-10 8:18 ` Johannes Schindelin
2021-06-10 14:42 ` Felipe Contreras
2021-06-14 22:10 ` Robert Karszniewicz
2021-06-07 16:57 ` [PATCH 2/4] *: use singular they in comments Derrick Stolee via GitGitGadget
2021-06-07 17:12 ` Ævar Arnfjörð Bjarmason
2021-06-07 17:20 ` Derrick Stolee
2021-06-10 8:20 ` Johannes Schindelin
2021-06-07 19:02 ` Junio C Hamano
2021-06-07 21:44 ` Felipe Contreras
2021-06-08 17:36 ` Emily Shaffer
2021-06-07 16:57 ` [PATCH 3/4] *: fix typos Derrick Stolee via GitGitGadget
2021-06-08 17:37 ` Emily Shaffer
2021-06-10 8:36 ` Johannes Schindelin
2021-06-10 19:53 ` Derrick Stolee
2021-06-11 9:55 ` Johannes Schindelin
2021-06-07 16:57 ` [PATCH 4/4] CodingGuidelines: recommend singular they Derrick Stolee via GitGitGadget
2021-06-07 18:31 ` Ævar Arnfjörð Bjarmason
2021-06-08 1:47 ` Felipe Contreras
2021-06-07 18:56 ` Junio C Hamano
2021-06-07 19:05 ` Derrick Stolee
2021-06-08 0:05 ` Junio C Hamano
2021-06-10 21:34 ` brian m. carlson
2021-06-10 8:39 ` Johannes Schindelin
2021-06-07 20:00 ` Felipe Contreras
2021-06-09 18:29 ` Phillip Susi
2021-06-09 20:18 ` Felipe Contreras
2021-06-07 20:20 ` Robert Karszniewicz
2021-06-07 22:18 ` Felipe Contreras
2021-06-08 7:10 ` Jeff King
2021-06-08 8:11 ` Felipe Contreras
2021-06-09 13:23 ` Derrick Stolee
2021-06-09 15:20 ` Felipe Contreras
2021-06-10 22:06 ` brian m. carlson
2021-06-11 16:11 ` Felipe Contreras
2021-06-08 17:39 ` Emily Shaffer
2021-06-09 4:44 ` Junio C Hamano
2021-06-09 13:27 ` Derrick Stolee
2021-06-07 20:10 ` [PATCH 0/4] Use singular "they" when appropriate Felipe Contreras
2021-06-09 13:54 ` [PATCH v2 " Derrick Stolee via GitGitGadget
2021-06-09 13:54 ` [PATCH v2 1/4] Documentation: use singular they " Derrick Stolee via GitGitGadget
2021-06-09 15:33 ` Felipe Contreras
2021-06-09 13:54 ` [PATCH v2 2/4] *: use singular they in comments Derrick Stolee via GitGitGadget
2021-06-09 15:41 ` Felipe Contreras
2021-06-09 13:54 ` [PATCH v2 3/4] *: fix typos Derrick Stolee via GitGitGadget
2021-06-09 13:54 ` [PATCH v2 4/4] CodingGuidelines: recommend singular they Derrick Stolee via GitGitGadget
2021-06-09 15:50 ` Felipe Contreras
2021-06-09 15:44 ` [PATCH v2 0/4] Use singular "they" when appropriate Ævar Arnfjörð Bjarmason
2021-06-09 17:22 ` Felipe Contreras
2021-06-10 2:03 ` Junio C Hamano
2021-06-10 2:28 ` Junio C Hamano
2021-06-10 3:30 ` Felipe Contreras
2021-06-10 22:32 ` brian m. carlson
2021-06-10 22:58 ` Ævar Arnfjörð Bjarmason
2021-06-11 16:32 ` Felipe Contreras
2021-06-11 17:18 ` Derrick Stolee
2021-06-11 20:38 ` Felipe Contreras
2021-06-13 7:17 ` Ævar Arnfjörð Bjarmason
2021-06-15 6:02 ` Junio C Hamano
2021-06-15 13:36 ` Derrick Stolee
2021-06-15 17:03 ` Felipe Contreras
2021-06-14 0:47 ` Junio C Hamano
2021-06-15 14:11 ` [PATCH v3 0/4] Avoid gendered pronouns Derrick Stolee via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 1/4] doc: avoid using the gender of other people Felipe Contreras via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 2/4] comments: avoid using the gender of our users Felipe Contreras via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 3/4] *: fix typos Derrick Stolee via GitGitGadget
2021-06-15 14:11 ` [PATCH v3 4/4] CodingGuidelines: recommend singular they Derrick Stolee via GitGitGadget
2021-06-15 16:19 ` Ævar Arnfjörð Bjarmason
2021-06-15 17:26 ` Felipe Contreras
2021-06-16 2:47 ` Junio C Hamano
2021-06-16 5:06 ` Junio C Hamano [this message]
2021-06-16 9:26 ` Bagas Sanjaya
2021-06-16 17:44 ` Derrick Stolee
2021-06-16 19:54 ` Ævar Arnfjörð Bjarmason
2021-06-16 23:22 ` Felipe Contreras
2021-06-17 0:09 ` Junio C Hamano
2021-06-17 13:22 ` Derrick Stolee
2021-06-17 14:53 ` Ævar Arnfjörð Bjarmason
2021-06-17 17:06 ` Felipe Contreras
2021-06-17 15:25 ` Felipe Contreras
2021-06-18 0:26 ` brian m. carlson
2021-06-18 16:12 ` Felipe Contreras
2021-06-17 15:23 ` Felipe Contreras
2021-06-17 15:58 ` Ævar Arnfjörð Bjarmason
2021-06-18 0:53 ` brian m. carlson
2021-06-18 7:24 ` Ævar Arnfjörð Bjarmason
2021-06-18 16:40 ` Felipe Contreras
2021-06-19 7:03 ` Junio C Hamano
2021-06-28 22:32 ` Junio C Hamano
2021-06-29 1:31 ` Felipe Contreras
2021-06-29 1:53 ` Derrick Stolee
2021-06-29 12:29 ` Ævar Arnfjörð Bjarmason
2021-06-17 15:12 ` Felipe Contreras
2021-06-17 14:46 ` Felipe Contreras
2021-06-15 17:08 ` Felipe Contreras
2021-06-12 4:40 ` [PATCH 0/4] Use singular "they" when appropriate Bagas Sanjaya
2021-06-12 14:19 ` Phillip Susi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqbl86qtyf.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=avarab@gmail.com \
--cc=avoidr@posteo.de \
--cc=bagasdotme@gmail.com \
--cc=derrickstolee@github.com \
--cc=dstolee@microsoft.com \
--cc=emilyshaffer@google.com \
--cc=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=jrnieder@gmail.com \
--cc=peff@peff.net \
--cc=phill@thesusis.net \
--cc=richard.kerry@atos.net \
--cc=rybak.a.v@gmail.com \
--cc=sandals@crustytoothpaste.net \
--cc=stolee@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).