[DOC] Change to guidance on lists in What's Here section #5618
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BurdetteLamar
changed the title
jeremyevans
requested changes
Mar 2, 2022
There was a problem hiding this comment.
I've always disliked RDoc's use of dl/dt/dd for labeled lists. Even if it is semantically better, it generally doesn't look good. A table-based approach, while not as good semantically, generally looks better. However, unless we can change RDoc, switching to a simple list seems best.
In terms of the text, after two small typo fixes, this can be committed after a couple days unless someone objects. I want to allow more time here because this is changing the guide for writing documentation, so it's a change in our process and we should allow more time for comment/review.
doc/documentation_guide.rdoc
Outdated
| the method and linked to it; if not, manually insert a | ||
| {link}[https://docs.ruby-lang.org/en/master/RDoc/Markup.html#class-RDoc::Markup-label-Links]. | ||
|
|
||
| - If there are numerout entries, consider gouping them into subsections with headers. |
There was a problem hiding this comment.
s/numerout/numerous/
s/gouping/grouping/
jeremyevans
approved these changes
Mar 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the guide says a "What's Here" section should have a labeled list for the methods. Such a list can render very differently in different browsers, and are often erratic in their indentation of continuation lines.
The proposed guidance is to use a bullet list. If approved, I will modify the existing sections piecemeal.