diff options
| author | Jeremy Evans <code@jeremyevans.net> | 2023-02-19 11:58:00 -0800 |
|---|---|---|
| committer | Jeremy Evans <code@jeremyevans.net> | 2023-02-19 11:58:00 -0800 |
| commit | 59f7bf96d6d7655e94025f662ef995a90056949f (patch) | |
| tree | 5e617fa877238774f456adddaadc926e3ac81fbc /doc | |
| parent | ea50765926b480122baa8b72e67fee144e072066 (diff) | |
| download | ruby-59f7bf96d6d7655e94025f662ef995a90056949f.tar.gz | |
Mention when it is appropriate to document aliases in call-seq
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing/documentation_guide.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index f0880b0fd3..e138550039 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -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 |