1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Change to handling of aliases (#7340)

Browse Source 
Change to handling of aliases
This commit is contained in:
Burdette Lamar 2023-02-19 13:41:32 -06:00 committed by GitHub
parent 759d23584e
commit ea50765926
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
Notes: git 2023-02-19 19:42:00 +00:00 
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
1 changed files with 1 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/contributing/documentation_guide.md
View File

@ -241,7 +241,6 @@ The general structure of the method documentation should be:
- Details and examples. - Details and examples.
- Argument description (if necessary). - Argument description (if necessary).
- Corner cases and exceptions. - Corner cases and exceptions.
- Aliases.
- Related methods (optional). - Related methods (optional).
### Calling Sequence (for methods written in C) ### Calling Sequence (for methods written in C)
@ -328,7 +327,7 @@ Return types:
Aliases: Aliases:
- Omit aliases from the `call-seq`, but mention them near the end (see below). - Omit aliases from the `call-seq`.
### Synopsis ### 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 is passed. Do not provide examples of exceptions being raised unless
that is a common case, such as `Hash#fetch` raising a `KeyError`. 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) ### Related Methods (optional)
In some cases, it is useful to document which methods are related to In some cases, it is useful to document which methods are related to