Skip to content

Commit

Permalink
[DOC] More on What's Here (#9099)
Browse files Browse the repository at this point in the history
* More on What's Here

* More on What's Here
  • Loading branch information
BurdetteLamar committed Dec 2, 2023
1 parent d169161 commit 715cf9b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/contributing/documentation_guide.md
Expand Up @@ -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.
Expand Down

0 comments on commit 715cf9b

Please sign in to comment.