kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

[DOC] Addition to section 'Related Methods' (#6271)

Browse source 
Addition to section 'Related Methods':  suggests adding differentiators to the names of related methods.
This commit is contained in:
Burdette Lamar 2022-08-22 13:17:05 -05:00 committed by GitHub
parent a9ee13365a
commit aeac8b6c3a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
Notes: git 2022-08-23 03:17:33 +09:00 
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/contributing/documentation_guide.md
View file

@ -376,12 +376,22 @@ Mention aliases in the form
In some cases, it is useful to document which methods are related to
the current method. For example, documentation for `Hash#[]` might
mention `Hash#fetch` as a related method, and `Hash#merge` might mention
`Hash#merge!` as a related method. Consider which methods may be related
`Hash#merge!` as a related method.
- Consider which methods may be related
to the current method, and if you think the reader would benefit it,
at the end of the method documentation, add a line starting with
"Related: " (e.g. "Related: #fetch"). Don't list more than three
related methods. If you think more than three methods are related,
pick the three you think are most important and list those three.
"Related: " (e.g. "Related: #fetch.").
- Don't list more than three related methods.
If you think more than three methods are related,
list the three you think are most important.
- Consider adding:
- A phrase suggesting how the related method is similar to,
or different from,the current method.
See an example at Time#getutc.
- Example code that illustrates the similarities and differences.
See examples at Time#ctime, Time#inspect, Time#to_s.
### Methods Accepting Multiple Argument Types