diff options
Diffstat (limited to 'doc/contributing/documentation_guide.md')
| -rw-r--r-- | doc/contributing/documentation_guide.md | 13 |
1 files changed, 13 insertions, 0 deletions
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: + <tt>::bar</tt>, <tt>#baz</tt>. +- Otherwise, include the class or module name + and use a dot for a singleton method, + or a hash mark for an instance method: + <tt>Foo.bar</tt>, <tt>Foo#baz</tt>. + ### Auto-Linking In general, \RDoc's auto-linking should not be suppressed. |