Commit e247f19
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: #19269
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent be20914 commit e247f19
1 file changed
Lines changed: 2 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -14,9 +14,8 @@ | |||
| 14 | 14 | "color" vs. "colour", etc. | |
| 15 | 15 | * Use [serial commas][]. | |
| 16 | 16 | * Avoid personal pronouns in reference documentation ("I", "you", "we"). | |
| 17 | - * Pronouns are acceptable in more colloquial documentation, like guides. | ||
| 18 | - * Use gender-neutral pronouns and mass nouns. Non-comprehensive | ||
| 19 | - examples: | ||
| 17 | + * Personal pronouns are acceptable in colloquial documentation such as guides. | ||
| 18 | + * Use gender-neutral pronouns and gender-neutral plural nouns. | ||
| 20 | 19 | * OK: "they", "their", "them", "folks", "people", "developers" | |
| 21 | 20 | * NOT OK: "his", "hers", "him", "her", "guys", "dudes" | |
| 22 | 21 | * When combining wrapping elements (parentheses and quotes), terminal | |
0 commit comments