diff options
| author | Xavier Noria <fxn@hashref.com> | 2011-04-03 22:22:03 +0200 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2011-04-03 22:22:03 +0200 |
| commit | 3e24e9ebc22f96f9124d3a5d1c83b93c1bea937d (patch) | |
| tree | 31698977fbf077d079c70e5b258abc87042b5346 /railties/guides/source/api_documentation_guidelines.textile | |
| parent | a000fc58b8bc288ca9c60566afc1e1943f5d6083 (diff) | |
| parent | 4c323bc25a69ba8fd8b080775335184fe6868747 (diff) | |
| download | rails-3e24e9ebc22f96f9124d3a5d1c83b93c1bea937d.tar.gz rails-3e24e9ebc22f96f9124d3a5d1c83b93c1bea937d.tar.bz2 rails-3e24e9ebc22f96f9124d3a5d1c83b93c1bea937d.zip | |
Merge branch 'master' of git://github.com/lifo/docrails
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 7433507866..e22ffa4c04 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. 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. +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". |