]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): clarify `:help inclusion` section
authorErnie Rael <errael@raelity.com>
Sat, 11 Nov 2023 08:09:47 +0000 (09:09 +0100)
committerChristian Brabandt <cb@256bit.org>
Sat, 11 Nov 2023 08:10:24 +0000 (09:10 +0100)
Signed-off-by: Ernie Rael <errael@raelity.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/helphelp.txt
runtime/doc/tags

index 2f1e3be6e76b60c23f35fe48337a1729ee311111..61bd218487aeff16289d93945f0abbe74ccbfa9d 100644 (file)
@@ -394,17 +394,25 @@ highlighting.  So do these:
 
 You can find the details in $VIMRUNTIME/syntax/help.vim
 
-                                                       *inclusion*
-Vim is for everybody, no matter race, gender or anything.  Some people make a
-big deal about using "he" or "his" when referring to the user, thinking it
-means we assume the user is male.  That is not the case, it's just a habit of
-writing help text, which quite often is many years old.  Also, a lot of the
-text is written by contributors for whom English is not their first language.
-We do not make any assumptions about the gender of the user, no matter how the
-text is phrased.  Some people have suggested using "they", but that is not
-regular English. We do not want to spend much time on this discussion.  The
-goal is that the reader understands how Vim works, the exact wording is
+
+GENDER NEUTRAL LANGUAGE
+
+                                               *gender-neutral* *inclusion*
+Vim is for everybody, no matter race, gender or anything. For new or updated
+help text, gender neutral language is recommended. Some of the help text is
+many years old and there is no need to change it. We do not make any
+assumptions about the gender of the user, no matter how the text is phrased.
+The goal is that the reader understands how Vim works, the exact wording is
 secondary.
 
+Many online technical style guides include sections about gender neutral
+language. Here are a few: >
+
+       https://developers.google.com/style/pronouns
+       https://techwhirl.com/gender-neutral-technical-writing/
+       https://www.skillsyouneed.com/write/gender-neutral-language.html
+       https://ualr.edu/writingcenter/avoid-sexist-language/
+<
+Note: gender neutral language does not require using singular "they".
 
  vim:tw=78:ts=8:noet:ft=help:norl:
index efd2841f77939591b24d71e90f75593d227a9196..15193fdb7631981eaf43dd59afbd9aa5b60cc351 100644 (file)
@@ -7670,6 +7670,7 @@ gd        pattern.txt     /*gd*
 gdb    debug.txt       /*gdb*
 gdb-version    terminal.txt    /*gdb-version*
 ge     motion.txt      /*ge*
+gender-neutral helphelp.txt    /*gender-neutral*
 get()  builtin.txt     /*get()*
 get-ms-debuggers       debug.txt       /*get-ms-debuggers*
 getbufinfo()   builtin.txt     /*getbufinfo()*