Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
znz committed Aug 23, 2020
1 parent 4f7ff9c commit 30ccc7d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/method_documentation.rdoc
Expand Up @@ -5,7 +5,7 @@ classes and classes in the standard library.

== Goal

The goal when documentating a method is to impart the most important
The goal when documenting a method is to impart the most important
information about the method in the least amount of time. A reader
of the method documentation should be able to quickly understand
the purpose of the method and how to use it. Providing too little
Expand Down Expand Up @@ -49,7 +49,7 @@ method returns the receiver, use "self".

In cases where the method accepts optional arguments, use a <tt>call-seq</tt>
with an optional argument if the method has the same behavior when an argument
is ommitted as when the argument is passed with the default value. For example,
is omitted as when the argument is passed with the default value. For example,
use:

* obj.respond_to?(symbol, include_all=false) -> true or false
Expand All @@ -60,7 +60,7 @@ Instead of:
* obj.respond_to?(symbol, include_all) -> true or false

However, as shown above for <tt>Array#count</tt>, use separate lines if the
behavior is different if the argument is ommitted.
behavior is different if the argument is omitted.

== Synopsis

Expand Down Expand Up @@ -107,7 +107,7 @@ provide details about the types of arguments supported. When discussing
the types of arguments, use simple language even if less-precise, such
as "level must be an integer", not "level must be an Integer-convertible
object". The vast majority of use will be with the expected type, not an
argument that is explicitly convertable to the expected type, and
argument that is explicitly convertible to the expected type, and
documenting the difference is not important.

For methods that take blocks, it can be useful to document the type of
Expand Down

0 comments on commit 30ccc7d

Please sign in to comment.