Skip to content

doc: remove personal pronoun guidance from style guide #19186

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

Closed
Trott wants to merge 1 commit into from
Closed

doc: remove personal pronoun guidance from style guide #19186

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
doc: remove personal pronoun guidance 
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
Trott committed Mar 6, 2018
commit 32b062e2c772d76a84f09dc1ac0a06976eef14a4
10 changes: 3 additions & 7 deletions doc/STYLE_GUIDE.md
View file
Open in desktop
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.
Copy link
Copy Markdown
Member

@mcollina mcollina Mar 7, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would replace Generally with Try to. It should not prevent something from landing, but it would be best fixed.

* 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"
Copy link
Copy Markdown
Contributor

@vkurchatkin vkurchatkin Mar 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about we remove "cats" while we are here? I know, it is supposed to be funny, but it doesn't seem appropriate.

* 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