📚 Consistent heading levels inside method rdoc #361
Merged
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
All headings inside Net::IMAP method rdoc have been set to `h4`. This assumes that the method documentation is already three levels deep: * `<h1>` -- the page title, i.e: the class name * `<h2>` -- the category, i.e: "Instance Methods" * `<h3>` -- the method name The first two heading levels _are_ defined on the page, but the third level is unfortunately output as a `<div>`, not an `<h3>`.
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.
All headings inside Net::IMAP method rdoc have been set to
h4. This assumes that the method documentation is already three levels deep:<h1>-- the page title, i.e: the class name<h2>-- the category, i.e: "Instance Methods"<h3>-- the method nameThe first two heading levels are handled correctly by rdoc, but the third level is unfortunately output as a
<div>, not an<h3>. (TODO: make aruby/rdocPR to fix this.)