diff options
| author | Dmitry Polushkin <dmitry.polushkin@gmail.com> | 2011-10-01 20:49:14 +0100 |
|---|---|---|
| committer | Dmitry Polushkin <dmitry.polushkin@gmail.com> | 2011-10-01 20:49:14 +0100 |
| commit | 19965402b2f868c79d78269ca17cb6282f271382 (patch) | |
| tree | 8635415f386595650c27469d6b6d04335121d070 /railties/guides/source/api_documentation_guidelines.textile | |
| parent | 9d54f8994d09db5435d6c234430ae13333928fb9 (diff) | |
| parent | ec53b802dab9b676dcc9b53e542bcd840983b7a2 (diff) | |
| download | rails-19965402b2f868c79d78269ca17cb6282f271382.tar.gz rails-19965402b2f868c79d78269ca17cb6282f271382.tar.bz2 rails-19965402b2f868c79d78269ca17cb6282f271382.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 | 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 c0f709eda8..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. |