aboutsummaryrefslogtreecommitdiffstats
path: root/guides
diff options
context:
space:
mode:
authorXavier Noria <fxn@hashref.com>2013-12-12 21:48:33 +0100
committerXavier Noria <fxn@hashref.com>2013-12-12 21:48:33 +0100
commita176bd095c3cba498369870681695bb29a68f0f9 (patch)
tree588f07f2716da1e0657166b51c98d3685fc04756 /guides
parent6814c78b6793f4bee4278daa8b6dc5e269b2f06a (diff)
downloadrails-a176bd095c3cba498369870681695bb29a68f0f9.tar.gz
rails-a176bd095c3cba498369870681695bb29a68f0f9.tar.bz2
rails-a176bd095c3cba498369870681695bb29a68f0f9.zip
docs guidelines: recommends wording in a way that avoids "you"s and "your"s
Diffstat (limited to 'guides')
-rw-r--r--guides/source/api_documentation_guidelines.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md
index ccb51ce73c..31ef18d21e 100644
--- a/guides/source/api_documentation_guidelines.md
+++ b/guides/source/api_documentation_guidelines.md
@@ -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.