aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/api_documentation_guidelines.md
diff options
context:
space:
mode:
authorSunny Ripert <sunny@sunfox.org>2013-05-28 14:19:22 +0200
committerSunny Ripert <sunny@sunfox.org>2013-05-28 14:38:01 +0200
commit666d028bb82428a0649935b1d1814db0e20a406f (patch)
tree64e90068f92775926528d4d6d11a2eb97f32b1a4 /guides/source/api_documentation_guidelines.md
parentff684ea3bfa7e448b60f6ab2e8f3feb60f48d7f9 (diff)
downloadrails-666d028bb82428a0649935b1d1814db0e20a406f.tar.gz
rails-666d028bb82428a0649935b1d1814db0e20a406f.tar.bz2
rails-666d028bb82428a0649935b1d1814db0e20a406f.zip
End-of-line whitespace hunt
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
-rw-r--r--guides/source/api_documentation_guidelines.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md
index d0499878da..d2fdbc7ac0 100644
--- a/guides/source/api_documentation_guidelines.md
+++ b/guides/source/api_documentation_guidelines.md
@@ -25,7 +25,7 @@ Write in present tense: "Returns a hash that...", rather than "Returned a hash t
Start comments in upper case. Follow regular punctuation rules:
```ruby
-# Declares an attribute reader backed by an internally-named
+# Declares an attribute reader backed by an internally-named
# instance variable.
def attr_internal_reader(*attrs)
...
@@ -57,7 +57,7 @@ Use two spaces to indent chunks of code--that is, for markup purposes, two space
Short docs do not need an explicit "Examples" label to introduce snippets; they just follow paragraphs:
```ruby
-# Converts a collection of elements into a formatted string by
+# Converts a collection of elements into a formatted string by
# calling +to_s+ on all elements and joining them.
#
# Blog.all.to_formatted_s # => "First PostSecond PostThird Post"