Skip to content

Commit 459690a

Browse files
TrottBethGriggs
authored andcommitted
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 <[email protected]>
1 parent 4bcdc1b commit 459690a

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

doc/STYLE_GUIDE.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@
1616
"color" vs. "colour", etc.
1717
* Use [serial commas][].
1818
* Avoid personal pronouns in reference documentation ("I", "you", "we").
19-
* Pronouns are acceptable in more colloquial documentation, like guides.
20-
* Use gender-neutral pronouns and mass nouns. Non-comprehensive
21-
examples:
19+
* Personal pronouns are acceptable in colloquial documentation such as guides.
20+
* Use gender-neutral pronouns and gender-neutral plural nouns.
2221
* OK: "they", "their", "them", "folks", "people", "developers"
2322
* NOT OK: "his", "hers", "him", "her", "guys", "dudes"
2423
* When combining wrapping elements (parentheses and quotes), terminal

0 commit comments

Comments
 (0)