aboutsummaryrefslogtreecommitdiffstats
path: root/railties/guides/source/api_documentation_guidelines.textile
diff options
context:
space:
mode:
authorXavier Noria <fxn@hashref.com>2011-02-18 23:22:15 +0100
committerXavier Noria <fxn@hashref.com>2011-02-18 23:22:15 +0100
commitf41bf6938fd4aa5a83777cc767f7f32ace5f6539 (patch)
treeeb85baf61ec970ca090ed057536c2d0ee1b18e5b /railties/guides/source/api_documentation_guidelines.textile
parentfbfa30a1eeaaab22ac8f43a4137ec8282920fe15 (diff)
parent220cb107b672d65fdc0488d4ff310ab04b62b463 (diff)
downloadrails-f41bf6938fd4aa5a83777cc767f7f32ace5f6539.tar.gz
rails-f41bf6938fd4aa5a83777cc767f7f32ace5f6539.tar.bz2
rails-f41bf6938fd4aa5a83777cc767f7f32ace5f6539.zip
merges docrails
Diffstat (limited to 'railties/guides/source/api_documentation_guidelines.textile')
-rw-r--r--railties/guides/source/api_documentation_guidelines.textile2
1 files changed, 1 insertions, 1 deletions
diff --git a/railties/guides/source/api_documentation_guidelines.textile b/railties/guides/source/api_documentation_guidelines.textile
index 68665dce98..7433507866 100644
--- a/railties/guides/source/api_documentation_guidelines.textile
+++ b/railties/guides/source/api_documentation_guidelines.textile
@@ -27,7 +27,7 @@ Communicate to the reader the current way of doing things, both explicitly and i
Documentation has to be concise but comprehensive. Explore and document edge cases. What happens if a module is anonymous? What if a collection is empty? What if an argument is nil?
-The proper names of Rails components have a space in between the words, like "Active Support". +ActiveRecord+ is a Ruby module, whereas Active Record is an ORM. All Rails documentation should consistently refer to Rails components by their proper name, and if in your next blog post or presentation you remember this tidbit and take it into account that'd be fenomenal :).
+The proper names of Rails components have a space in between the words, like "Active Support". +ActiveRecord+ is a Ruby module, whereas Active Record is an ORM. All Rails documentation should consistently refer to Rails components by their proper name, and if in your next blog post or presentation you remember this tidbit and take it into account that'd be phenomenal.
Spell names correctly: Arel, Test::Unit, RSpec, HTML, MySQL, JavaScript, ERb. When in doubt, please have a look at some authoritative source like their official documentation.