diff options
| author | Nat Welch <nat@natwelch.com> | 2011-09-21 23:53:18 -0700 |
|---|---|---|
| committer | Nat Welch <nat@natwelch.com> | 2011-09-21 23:53:18 -0700 |
| commit | 667d21814b67c615d3317488d0678cb992d3bdb1 (patch) | |
| tree | d10e68a7d904641f88e6e835074273ab0bcafbc4 /railties/guides/source/api_documentation_guidelines.textile | |
| parent | f69036781c0ee7a22a456fe3a6689277d44ed9a6 (diff) | |
| parent | 2bf33bd4bcd488a35e641b32dd667f3092ea9197 (diff) | |
| download | rails-667d21814b67c615d3317488d0678cb992d3bdb1.tar.gz rails-667d21814b67c615d3317488d0678cb992d3bdb1.tar.bz2 rails-667d21814b67c615d3317488d0678cb992d3bdb1.zip | |
Merge branch 'master' of git://github.com/rails/rails
Diffstat (limited to 'railties/guides/source/api_documentation_guidelines.textile')
| -rw-r--r-- | railties/guides/source/api_documentation_guidelines.textile | 6 |
1 files changed, 1 insertions, 5 deletions
diff --git a/railties/guides/source/api_documentation_guidelines.textile b/railties/guides/source/api_documentation_guidelines.textile index 3ebf0e10f1..99eb668513 100644 --- a/railties/guides/source/api_documentation_guidelines.textile +++ b/railties/guides/source/api_documentation_guidelines.textile @@ -146,7 +146,7 @@ h3. Description Lists In lists of options, parameters, etc. use a hyphen between the item and its description (reads better than a colon because normally options are symbols): <ruby> -# * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+. +# * <tt>:allow_nil</tt> - Skip validation if attribute is <tt>nil</tt>. </ruby> The description starts in upper case and ends with a full stop—it's standard English. @@ -183,7 +183,3 @@ self.class_eval %{ end } </ruby> - -h3. Changelog - -* July 17, 2010: ported from the docrails wiki and revised by "Xavier Noria":credits.html#fxn |