1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] More on What's Here (#9099)

Browse Source 
* More on What's Here

* More on What's Here
This commit is contained in:
Burdette Lamar 2023-12-02 11:46:57 -06:00 committed by GitHub
parent d1691617d6
commit 715cf9b690
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/contributing/documentation_guide.md
View File

@ -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.