kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

docs guidelines: recommends wording in a way that avoids "you"s and "your"s

Browse source
This commit is contained in:
Xavier Noria 2013-12-12 21:48:33 +01:00
parent 6814c78b67
commit a176bd095c
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
guides/source/api_documentation_guidelines.md
View file

@ -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.