Skip to content

Commit

Permalink
docs guidelines: recommends wording in a way that avoids "you"s and "…
Browse files Browse the repository at this point in the history
…your"s
  • Loading branch information
fxn committed Dec 12, 2013
1 parent 6814c78 commit a176bd0
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion guides/source/api_documentation_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,21 @@ Spell names correctly: Arel, Test::Unit, RSpec, HTML, MySQL, JavaScript, ERB. Wh

Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database".

When using pronouns in reference to a hypothetical person, such as "a user with a session cookie", gender neutral pronouns (they/their/them) should be used. Instead of:
Prefer wordings that avoid "you"s and "your"s. For example, instead of

```markdown
If you need to use `return` statements in your callbacks, it is recommended that you explicitly define them as methods.
```

use this style:

```markdown
If `return` is needed it is recommended to explicitly define a method.
```

That said, when using pronouns in reference to a hypothetical person, such as "a
user with a session cookie", gender neutral pronouns (they/their/them) should be
used. Instead of:

* he or she... use they.
* him or her... use them.
Expand Down

0 comments on commit a176bd0

Please sign in to comment.