aboutsummaryrefslogtreecommitdiffstats
path: root/railties/guides/source/api_documentation_guidelines.textile
diff options
context:
space:
mode:
authorMichael Lavrisha <michael.lavrisha@gmail.com>2011-07-24 13:59:52 -0600
committerMichael Lavrisha <michael.lavrisha@gmail.com>2011-07-24 13:59:52 -0600
commit941fae2cbb070caf0abe902dd7b2ae091b240e72 (patch)
tree76f633e66cb19d38f0ce06d84cce1e5337e32b44 /railties/guides/source/api_documentation_guidelines.textile
parentc02288e6fda824a77f6097f4c03b026b8d6e4f49 (diff)
downloadrails-941fae2cbb070caf0abe902dd7b2ae091b240e72.tar.gz
rails-941fae2cbb070caf0abe902dd7b2ae091b240e72.tar.bz2
rails-941fae2cbb070caf0abe902dd7b2ae091b240e72.zip
Provide consistant indentation for the example code
Diffstat (limited to 'railties/guides/source/api_documentation_guidelines.textile')
-rw-r--r--railties/guides/source/api_documentation_guidelines.textile16
1 files changed, 8 insertions, 8 deletions
diff --git a/railties/guides/source/api_documentation_guidelines.textile b/railties/guides/source/api_documentation_guidelines.textile
index bab2be9188..9c4df2d6b8 100644
--- a/railties/guides/source/api_documentation_guidelines.textile
+++ b/railties/guides/source/api_documentation_guidelines.textile
@@ -78,14 +78,14 @@ The result of expressions follow them and are introduced by "# => ", vertically
If a line is too long, the comment may be placed on the next line:
<ruby>
- # label(:post, :title)
- # # => <label for="post_title">Title</label>
- #
- # label(:post, :title, "A short title")
- # # => <label for="post_title">A short title</label>
- #
- # label(:post, :title, "A short title", :class => "title_label")
- # # => <label for="post_title" class="title_label">A short title</label>
+# label(:post, :title)
+# # => <label for="post_title">Title</label>
+#
+# label(:post, :title, "A short title")
+# # => <label for="post_title">A short title</label>
+#
+# label(:post, :title, "A short title", :class => "title_label")
+# # => <label for="post_title" class="title_label">A short title</label>
</ruby>
Avoid using any printing methods like +puts+ or +p+ for that purpose.