diff options
| author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2023-12-02 11:46:57 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-02 11:46:57 -0600 |
| commit | 715cf9b6902b0cc317fbc5cea0df153e14ff7277 (patch) | |
| tree | 35fa739a65d6be03f99f8116be7d5916eb91ab06 | |
| parent | d1691617d6d6a115db52e7861f584fe98039ed1b (diff) | |
| download | ruby-715cf9b6902b0cc317fbc5cea0df153e14ff7277.tar.gz | |
[DOC] More on What's Here (#9099)
* More on What's Here
* More on What's Here
| -rw-r--r-- | doc/contributing/documentation_guide.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index 2192c12d46..027be34775 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -294,7 +294,10 @@ Guidelines: - Consider listing the parent class and any included modules; consider [links](rdoc-ref:RDoc::MarkupReference@Links) to their "What's Here" sections if those exist. -- List methods as a bullet list: +- All methods mentioned in the left-pane table of contents + should be listed (including any methods extended from another class). +- Attributes (which are not included in the TOC) may also be listed. +- Display methods as items in one or more bullet lists: - Begin each item with the method name, followed by a colon and a short description. |