diff options
| author | Xavier Noria <fxn@hashref.com> | 2010-09-21 23:50:45 +0200 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2010-09-21 23:50:57 +0200 |
| commit | a6aa6da5dd20beb93617ca97d565d7fed0a11130 (patch) | |
| tree | 0331064315cb42066517839f0e06e60fc731bbc6 /railties/guides/source | |
| parent | 88b1d51f825ec7369b2cc5f5004f662dd80a6057 (diff) | |
| download | rails-a6aa6da5dd20beb93617ca97d565d7fed0a11130.tar.gz rails-a6aa6da5dd20beb93617ca97d565d7fed0a11130.tar.bz2 rails-a6aa6da5dd20beb93617ca97d565d7fed0a11130.zip | |
api guidelines: adds Test::Unit and RSpec as examples of correct spelling, also advice when in doubt
Diffstat (limited to 'railties/guides/source')
| -rw-r--r-- | railties/guides/source/api_documentation_guidelines.textile | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/railties/guides/source/api_documentation_guidelines.textile b/railties/guides/source/api_documentation_guidelines.textile index 9aefc41a70..c2131ff450 100644 --- a/railties/guides/source/api_documentation_guidelines.textile +++ b/railties/guides/source/api_documentation_guidelines.textile @@ -29,7 +29,9 @@ Documentation has to be concise but comprehensive. Explore and document edge cas 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 :). -Spell names correctly: Arel, HTML, MySQL, JavaScript, ERb. Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database". +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. + +Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database". h3. Example Code |