[DOC] Mods about markup formats #1143
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
lib/rdoc/markup.rb
Outdated
| # | ||
| # - +rdoc+: | ||
| # the +RDoc+ markup format; | ||
| # see RDoc::Markup. |
There was a problem hiding this comment.
Doesn't this just link to the current file? There's not much information on that file. Isn't it more useful to link to MarkupReference?
There was a problem hiding this comment.
Not to the current file (RDoc/Markup.html), but to RDoc/Markdown.html. This bullet item is about markdown, not markup.
There was a problem hiding this comment.
I'm confused. This bullet point is for RDoc markup, not markdown.
There was a problem hiding this comment.
Duh. I'm the one who was confused. Now fixed to refer to RDoc::MarkupReference.
peterzhu2118
approved these changes
Jul 29, 2024
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Jul 29, 2024
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.
Clarifies (I hope) some things about markup formats.
I've purposely not mentioned
markupas an alias forrdocbecause I think it invites confusion.