git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Merlin (they/them) via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Merlin (they/them)" <merlinpatt+githubgit@gmail.com>,
	"Merlin (they/them) Patterson" <merlinpatt+githubgit@gmail.com>
Subject: [PATCH] docs: update coding guidelines to be more inclusive
Date: Wed, 16 Feb 2022 16:34:27 +0000	[thread overview]
Message-ID: <pull.1070.git.git.1645029267415.gitgitgadget@gmail.com> (raw)

From: "Merlin (they/them) Patterson" <merlinpatt+githubgit@gmail.com>

These changes make this documentation more inclusive.
Using "male" and "female" as examples of gender is unnecessary.
The use of "it" shouldn't be used to refer to people even in an
  example of what not to use. People are never "it"s.
There's no need to specify a person or group of people that
  learned "they" is only plural.

Signed-off-by: Merlin (they/them) Patterson <merlinpatt+githubgit@gmail.com>
---
    docs: Update CodingGuidelines to be more inclusive
    
    These changes make this documentation more inclusive.
    
     * Using "male" and "female" as examples of gender is unnecessary.
     * The use of "it" shouldn't be used to refer to people even in an
       example of what not to use. People are never "it"s.
     * There's no need to specify a person or group of people that learned
       "they" is only plural.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1070%2Fmerlinpatt%2Fpatch-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1070/merlinpatt/patch-1-v1
Pull-Request: https://github.com/git/git/pull/1070

 Documentation/CodingGuidelines | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 711cb9171e0..ffd7fa9c0f4 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -552,9 +552,9 @@ Writing Documentation:
  Documentation/SubmittingPatches file).
 
  In order to ensure the documentation is inclusive, avoid assuming
- that an unspecified example person is male or female, and think
- twice before using "he", "him", "she", or "her".  Here are some
- tips to avoid use of gendered pronouns:
+ the gender of an example person, and think twice before using
+ "he", "him", "she", or "her". Here are some tips to avoid the use
+ of gendered pronouns:
 
   - Prefer succinctness and matter-of-factly describing functionality
     in the abstract.  E.g.
@@ -566,8 +566,8 @@ Writing Documentation:
      --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...
+     --short:: Should a person and/or program want shorter output,
+               he/she/they can...
 
     This practice often eliminates the need to involve human actors in
     your description, but it is a good practice regardless of the
@@ -586,15 +586,13 @@ Writing Documentation:
       versions.
 
   - If you still need to refer to an example person that is
-    third-person singular, you may resort to "singular they" to avoid
+    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 that "they" is only used for third-person plural, e.g.
-    those who learn English as a second language in some parts of the
-    world.
+    learned that "they" is only used for third-person plural.
 
  Every user-visible change should be reflected in the documentation.
  The same general rule as for code applies -- imitate the existing

base-commit: 225bc32a989d7a22fa6addafd4ce7dcd04675dbf
-- 
gitgitgadget

             reply	other threads:[~2022-02-16 16:34 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-16 16:34 Merlin (they/them) via GitGitGadget [this message]
2022-02-16 22:12 ` [PATCH] docs: update coding guidelines to be more inclusive Junio C Hamano
2022-02-17 10:02   ` Ævar Arnfjörð Bjarmason
2022-02-18  3:02     ` Junio C Hamano
     [not found]       ` <CAFZ26y3re+fJapXzLOpf73F-ECXhg2sCoBtm_=VUFy5nbN2UVQ@mail.gmail.com>
2022-02-18 23:18         ` Ævar Arnfjörð Bjarmason
2022-02-20 21:23           ` brian m. carlson

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=pull.1070.git.git.1645029267415.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=merlinpatt+githubgit@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).