aboutsummaryrefslogtreecommitdiffstats
path: root/railties/guides/source/api_documentation_guidelines.textile
diff options
context:
space:
mode:
authorXavier Noria <fxn@hashref.com>2011-02-09 20:05:28 +0100
committerXavier Noria <fxn@hashref.com>2011-02-09 20:05:28 +0100
commitcb1f8413def871e7fd42064e5144dfeb8460c1fc (patch)
tree61d3e9cb2be5515739239286b846479def3c3472 /railties/guides/source/api_documentation_guidelines.textile
parent4083e0ea2ae6f87929a32935122f2427845098e0 (diff)
downloadrails-cb1f8413def871e7fd42064e5144dfeb8460c1fc.tar.gz
rails-cb1f8413def871e7fd42064e5144dfeb8460c1fc.tar.bz2
rails-cb1f8413def871e7fd42064e5144dfeb8460c1fc.zip
now that the API guidelines are a guide, it is enough to assert that the names of Rails components have a space, no need to say it was checked with David in the past
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 2bbb1b5919..68665dce98 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. Historically there has been lack of consistency regarding this, but we checked with David when docrails started. All Rails documentation 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 fenomenal :).
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.