From 459690aca46cd3c76093103fe390257190080280 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 9 Mar 2018 14:49:59 -0800 Subject: [PATCH] doc: improve style guide text * Specify that personal pronouns are OK in colloquial documentation rather than just pronouns. Pronouns are OK in all documentation. (For example, "it" is a pronoun and is acceptable in all types of documentation.) Specify "personal pronouns" for clarity. * more colloquial -> colloquial * like -> such as * Remove "mass nouns" as no mass nouns are given as examples. Plural nouns seems to be what was meant, so use that instead. * Repeat "gender-neutral" to make it clear that it refers to both terms and not merely the first term it appears before. * Remove "non-comprehensive examples". Examples are, by definition, non-comprehensive. No need to announce that the examples are examples. It is obvious. PR-URL: https://github.com/nodejs/node/pull/19269 Reviewed-By: Luigi Pinca --- doc/STYLE_GUIDE.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index b4ed5f932014cd..93d4b3a806aa01 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -16,9 +16,8 @@ "color" vs. "colour", etc. * Use [serial commas][]. * Avoid personal pronouns in reference documentation ("I", "you", "we"). - * Pronouns are acceptable in more colloquial documentation, like guides. - * Use gender-neutral pronouns and mass nouns. Non-comprehensive - examples: + * Personal pronouns are acceptable in colloquial documentation such as guides. + * Use gender-neutral pronouns and gender-neutral plural nouns. * OK: "they", "their", "them", "folks", "people", "developers" * NOT OK: "his", "hers", "him", "her", "guys", "dudes" * When combining wrapping elements (parentheses and quotes), terminal