aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/api_documentation_guidelines.md
diff options
context:
space:
mode:
authorVijay Dev <vijaydev.cse@gmail.com>2013-06-14 01:14:56 +0530
committerVijay Dev <vijaydev.cse@gmail.com>2013-06-14 01:14:56 +0530
commit41a398f859cc46430cb3b655d44c0cb3b41e42ae (patch)
tree1fefe6aa5560b49ca2142866080caaedaf2bf04d /guides/source/api_documentation_guidelines.md
parent930d0e129c730292ab987eaaf1cd2ba8094e580b (diff)
parent2f0a5c7ac506b900d101620c4cc338a88ee620e3 (diff)
downloadrails-41a398f859cc46430cb3b655d44c0cb3b41e42ae.tar.gz
rails-41a398f859cc46430cb3b655d44c0cb3b41e42ae.tar.bz2
rails-41a398f859cc46430cb3b655d44c0cb3b41e42ae.zip
Merge branch 'master' of github.com:lifo/docrails
Conflicts: guides/source/upgrading_ruby_on_rails.md
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
-rw-r--r--guides/source/api_documentation_guidelines.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md
index d0499878da..7e056d970c 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"
@@ -141,7 +141,7 @@ class Array
end
```
-WARNING: Using a pair of `+...+` for fixed-width font only works with **words**; that is: anything matching `\A\w+\z`. For anything else use `<tt>...</tt>`, notably symbols, setters, inline snippets, etc.
+WARNING: Using a pair of `+...+` for fixed-width font only works with **words**; that is: anything matching `\A\w+\z`. For anything else use `<tt>...</tt>`, notably symbols, setters, inline snippets, etc.
### Regular Font