From df1cc043017660156c9d7477e5799de803573a80 Mon Sep 17 00:00:00 2001 From: BurdetteLamar Date: Sat, 27 Jul 2024 16:18:09 +0100 Subject: [PATCH] Add remark about call-seq --- doc/contributing/documentation_guide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index 59953d0d52..942db9072d 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -360,6 +360,14 @@ For example, in Array, use: * <=> other -> -1, 0, 1, or nil ``` +For a binary-operator style method (e.g., Array#&), +cite `self` in the call-seq (not, e.g., `array` or `receiver`): + +``` +* call-seq: +* self & other_array -> new_array +``` + Arguments: - If the method does not accept arguments, omit the parentheses.