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

Mention when it is appropriate to document aliases in call-seq

Browse Source
This commit is contained in:
Jeremy Evans 2023-02-19 11:58:00 -08:00
parent ea50765926
commit 59f7bf96d6
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/contributing/documentation_guide.md
View File

@ -327,7 +327,11 @@ Return types:
Aliases:
- Omit aliases from the `call-seq`.
- Omit aliases from the `call-seq`, unless the alias is an
operator method. If listing both a regular method and an
operator method in the `call-seq`, explain in the details and
examples section when it is recommended to use the regular method
and when it is recommended to use the operator method.
### Synopsis