diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-03-09 14:49:59 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-03-12 20:27:10 -0700 |
| commit | 8ed0f3409a31abae87bf6aae394b8901c5e6ecab (patch) | |
| tree | 9f1030614b54fa6bab3cbf632e0be2f01d6e2df6 /doc/STYLE_GUIDE.md | |
| parent | ffd618bd5cde77e19ab6458eaf454c4df71dd638 (diff) | |
| download | android-node-v8-8ed0f3409a31abae87bf6aae394b8901c5e6ecab.tar.gz android-node-v8-8ed0f3409a31abae87bf6aae394b8901c5e6ecab.tar.bz2 android-node-v8-8ed0f3409a31abae87bf6aae394b8901c5e6ecab.zip | |
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 <luigipinca@gmail.com>
Diffstat (limited to 'doc/STYLE_GUIDE.md')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 7da30743cf..009b0ee2b5 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -14,9 +14,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 |