[DOC] Re-format section Directives #1418
Merged
Conversation
This file contains hidden or 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
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
doc/rdoc/markup_reference.rb
Outdated
Comment on lines
488
to
490
| # With argument +all+: | ||
| # specifies that the class or module should not be documented. | ||
| # By default, however, a nested class or module _will_ be documented. |
There was a problem hiding this comment.
Can you provide an example of how to use this? In the new documentation, it's not clear to me how this should be used.
doc/rdoc/markup_reference.rb
Outdated
| # parameter +type+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. | ||
| # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats]. | ||
| # - Appears on a line by itself. | ||
| # - Takes argument +format+. |
There was a problem hiding this comment.
IMO we should show where the argument goes. It's not immediate clear to me how to pass arguments to RDoc directives.
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
BurdetteLamar
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
BurdetteLamar
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
BurdetteLamar
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
BurdetteLamar
temporarily deployed
to
fork-preview-protection
GitHub Actions
Inactive
|
🚀 Preview deployment available at: https://74fc9862.rdoc-6cd.pages.dev (commit: db78913) |
peterzhu2118
approved these changes
Aug 29, 2025
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.
The goal here is to force the directive names into the left-frame TOC. I've tried to limit other changes to those needed for consistency.
This largish section needs other work, and will get it, but not in this PR.