diff options
| author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2023-02-19 13:41:32 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-19 13:41:32 -0600 |
| commit | ea50765926b480122baa8b72e67fee144e072066 (patch) | |
| tree | 50e177375575a5d6db106f606471f0150f258a06 /doc | |
| parent | 759d23584e8f0110e55c8c47db662b733e72e219 (diff) | |
| download | ruby-ea50765926b480122baa8b72e67fee144e072066.tar.gz | |
[DOC] Change to handling of aliases (#7340)
Change to handling of aliases
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing/documentation_guide.md | 11 |
1 files changed, 1 insertions, 10 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index 9cfd59d629..f0880b0fd3 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -241,7 +241,6 @@ The general structure of the method documentation should be: - Details and examples. - Argument description (if necessary). - Corner cases and exceptions. -- Aliases. - Related methods (optional). ### Calling Sequence (for methods written in C) @@ -328,7 +327,7 @@ Return types: Aliases: -- Omit aliases from the `call-seq`, but mention them near the end (see below). +- Omit aliases from the `call-seq`. ### Synopsis @@ -398,14 +397,6 @@ 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 a `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 |