Permalink
Browse files

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
  • Loading branch information...
1 parent 4083e0e commit cb1f8413def871e7fd42064e5144dfeb8460c1fc @fxn fxn committed Feb 9, 2011
Showing with 1 addition and 1 deletion.
  1. +1 −1 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.

5 comments on commit cb1f841

Contributor

jonnii replied Feb 10, 2011

fenomenal should probably be phenomenal, no?

Owner

spastorino replied Feb 10, 2011

jonnii please patch it in https://github.com/lifo/docrails
Thanks

Contributor

jonnii replied Feb 10, 2011

Done.

Member

vijaydev replied Feb 10, 2011

Jonnii, you could also directly commit to docrails instead of sending pull requests. Thanks!

Contributor

jonnii replied Feb 10, 2011

Done.

Please sign in to comment.