From bcb72f503c311e214545e77906efbbadd8313068 Mon Sep 17 00:00:00 2001 From: Burdette Lamar Date: Mon, 24 Oct 2022 08:56:13 -0500 Subject: [PATCH] [DOC] Add note about method names (#6620) --- doc/contributing/documentation_guide.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index e8a5c5e478..9cfd59d629 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -137,6 +137,19 @@ or [list](rdoc-ref:RDoc::Markup@Simple+Lists) should be preceded by and followed by a blank line. This is unnecessary for the HTML output, but helps in the `ri` output. +### \Method Names + +For a method name in text: + +- For a method in the current class or module, + use a double-colon for a singleton method, + or a hash mark for an instance method: + ::bar, #baz. +- Otherwise, include the class or module name + and use a dot for a singleton method, + or a hash mark for an instance method: + Foo.bar, Foo#baz. + ### Auto-Linking In general, \RDoc's auto-linking should not be suppressed.