diff options
| author | Vijay Dev <vijaydev.cse@gmail.com> | 2011-09-21 19:35:09 +0530 |
|---|---|---|
| committer | Vijay Dev <vijaydev.cse@gmail.com> | 2011-09-21 19:35:09 +0530 |
| commit | caa95ab6d826f4bb112c2911849ce03c7312af11 (patch) | |
| tree | 6d64a68ba038e0be20adecfa93dedc269dfdbec8 /railties/guides/source/api_documentation_guidelines.textile | |
| parent | 95646f44fdb7cfecaac049a11b8ecef781b42d98 (diff) | |
| parent | 3e80462b95808457eb1584195909e26887a1a40d (diff) | |
| download | rails-caa95ab6d826f4bb112c2911849ce03c7312af11.tar.gz rails-caa95ab6d826f4bb112c2911849ce03c7312af11.tar.bz2 rails-caa95ab6d826f4bb112c2911849ce03c7312af11.zip | |
Merge branch 'master' of 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 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. |