From 59f7bf96d6d7655e94025f662ef995a90056949f Mon Sep 17 00:00:00 2001 From: Jeremy Evans Date: Sun, 19 Feb 2023 11:58:00 -0800 Subject: Mention when it is appropriate to document aliases in call-seq --- doc/contributing/documentation_guide.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'doc') 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 -- cgit v1.2.1