aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/api_documentation_guidelines.md
diff options
context:
space:
mode:
authorGuillermo Iguaran <guilleiguaran@gmail.com>2014-05-21 22:18:57 -0500
committerGuillermo Iguaran <guilleiguaran@gmail.com>2014-05-21 22:18:57 -0500
commit88a3a5db5ef0d38e1d4a6464f1d0fbc28a990aac (patch)
treeb1b7d6e6d9fb411281453708ec09adc28b46152e /guides/source/api_documentation_guidelines.md
parent2fb2913b35c4a706f0207119ab0b3e89f61546a1 (diff)
parentd02c810e29080389ab26313ae75556081aa9ac63 (diff)
downloadrails-88a3a5db5ef0d38e1d4a6464f1d0fbc28a990aac.tar.gz
rails-88a3a5db5ef0d38e1d4a6464f1d0fbc28a990aac.tar.bz2
rails-88a3a5db5ef0d38e1d4a6464f1d0fbc28a990aac.zip
Merge pull request #15215 from JohnKellyFerguson/rename-posts-to-articles
Documentation: Rename Posts to Articles
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
-rw-r--r--guides/source/api_documentation_guidelines.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md
index f01675b50d..2a3bb4e34d 100644
--- a/guides/source/api_documentation_guidelines.md
+++ b/guides/source/api_documentation_guidelines.md
@@ -110,14 +110,14 @@ The results 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(:article, :title)
+# # => <label for="article_title">Title</label>
#
-# label(:post, :title, "A short title")
-# # => <label for="post_title">A short title</label>
+# label(:article, :title, "A short title")
+# # => <label for="article_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(:article, :title, "A short title", class: "title_label")
+# # => <label for="article_title" class="title_label">A short title</label>
```
Avoid using any printing methods like `puts` or `p` for that purpose.