Add alias treatment to method_documentation.rdoc (#3468)

* Add alias treatment to method_documentation.rdoc

1 files changed, 7 insertions, 0 deletions

diff --git a/doc/method_documentation.rdoc b/doc/method_documentation.rdoc
index 26abd8849f..0432216868 100644
--- a/doc/method_documentation.rdoc
+++ b/doc/method_documentation.rdoc
@@ -23,6 +23,7 @@ The general structure of the method documentation should be:
 * Details and Examples
 * Argument Description (if necessary)
 * Corner Cases and Exceptions
+* Aliases
 * Related Methods (optional)
 
 == call-seq (for methods written in C)
@@ -62,6 +63,8 @@ Instead of:
 However, as shown above for <tt>Array#count</tt>, use separate lines if the
 behavior is different if the argument is omitted.
 
+Omit aliases from the call-seq.
+
 == Synopsis
 
 The synopsis comes next, and is a short description of what the
@@ -131,6 +134,10 @@ you do not need to document that a TypeError is raised if a non-integer
 is passed.  Do not provide examples of exceptions being raised unless
 that is a common case, such as Hash#fetch raising KeyError.
 
+== Aliases
+
+Mention aliases in the form "Array#find_index is an alias for Array#index."
+
 == Related Methods (optional)
 
 In some cases, it is useful to document which methods are related to