diff options
| author | Brian Lopez <seniorlopez@gmail.com> | 2010-08-09 12:43:49 -0700 |
|---|---|---|
| committer | Brian Lopez <seniorlopez@gmail.com> | 2010-08-09 12:43:49 -0700 |
| commit | ee9c950f2fe0c7953f0a9ad6a53439da7a4e89bc (patch) | |
| tree | 1b3f6a3e49be0ebacb251de0c0fc12bf64e2e596 /railties/guides/source/api_documentation_guidelines.textile | |
| parent | d8b90114ddd2a432280d114b9fe4ef1fdb38d132 (diff) | |
| parent | 7171161124a2852ee7b40c5c632ba8e092c97409 (diff) | |
| download | rails-ee9c950f2fe0c7953f0a9ad6a53439da7a4e89bc.tar.gz rails-ee9c950f2fe0c7953f0a9ad6a53439da7a4e89bc.tar.bz2 rails-ee9c950f2fe0c7953f0a9ad6a53439da7a4e89bc.zip | |
bringing over latest from master
Diffstat (limited to 'railties/guides/source/api_documentation_guidelines.textile')
| -rw-r--r-- | railties/guides/source/api_documentation_guidelines.textile | 2 |
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 d9a0d39d9d..9f201de49b 100644 --- a/railties/guides/source/api_documentation_guidelines.textile +++ b/railties/guides/source/api_documentation_guidelines.textile @@ -29,7 +29,7 @@ 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: HTML, MySQL, JavaScript, ERb. +Spell names correctly: HTML, MySQL, JavaScript, ERb. Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite database". h3. Example Code |