aboutsummaryrefslogtreecommitdiffstats
path: root/railties/guides/source/api_documentation_guidelines.textile
diff options
context:
space:
mode:
authorVijay Dev <vijaydev.cse@gmail.com>2011-09-16 22:12:41 +0530
committerVijay Dev <vijaydev.cse@gmail.com>2011-09-16 23:22:50 +0530
commit27f1320fde03279c575693f504897f1a6171bc59 (patch)
tree0385edc63d63eeee990e036aba19217cb01c55c5 /railties/guides/source/api_documentation_guidelines.textile
parent8411f631c42de7d6f51d10d997b037b9eff0d1f1 (diff)
downloadrails-27f1320fde03279c575693f504897f1a6171bc59.tar.gz
rails-27f1320fde03279c575693f504897f1a6171bc59.tar.bz2
rails-27f1320fde03279c575693f504897f1a6171bc59.zip
Fixing incorrect notextile tags
Diffstat (limited to 'railties/guides/source/api_documentation_guidelines.textile')
-rw-r--r--railties/guides/source/api_documentation_guidelines.textile2
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.