Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: minor style guide updates #19246

Closed
wants to merge 2 commits into from
Closed

doc: minor style guide updates #19246

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca57f05
doc: remove superfluous adverb from style guide
Trott Mar 8, 2018
17da735
doc: remove confusing "cats" from style guide
Trott Mar 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions doc/STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@
* American English spelling is preferred. "Capitalize" vs. "Capitalise",
"color" vs. "colour", etc.
* Use [serial commas][].
* Generally avoid personal pronouns in reference documentation ("I", "you",
"we").
* 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:
* OK: "they", "their", "them", "folks", "people", "developers", "cats"
* OK: "they", "their", "them", "folks", "people", "developers"
* NOT OK: "his", "hers", "him", "her", "guys", "dudes"
* When combining wrapping elements (parentheses and quotes), terminal
punctuation should be placed:
Expand Down