Skip to content

Commit

Permalink
doc: remove personal pronoun guidance
Browse files Browse the repository at this point in the history
In order to facilitate a more formal voice, the style guide recommends
avoiding personal pronouns. In practice, this results in lots of nits
for our docs without actually improving them. There are lots of ways our
docs can be improved. Making them more formal seems low value,
especially for all the PR comments this guidance generates.

So, remove that guidance from the style guide.
  • Loading branch information
Trott committed Mar 6, 2018
1 parent 78a7536 commit 32b062e
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions doc/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,9 @@
* 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").
* 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"
* NOT OK: "his", "hers", "him", "her", "guys", "dudes"
* Use gender-neutral pronouns and mass nouns. Non-comprehensive examples:
* OK: "they", "their", "them", "folks", "people", "developers", "cats"
* NOT OK: "his", "hers", "him", "her", "guys", "dudes"
* When combining wrapping elements (parentheses and quotes), terminal
punctuation should be placed:
* Inside the wrapping element if the wrapping element contains a complete
Expand Down

0 comments on commit 32b062e

Please sign in to comment.