[DOC] Tweaks for markup reference intro #1411
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
| # a function that implements a Ruby method, | ||
| # or otherwise immediately precedes the definition of a Ruby object, | ||
| # becomes the documentation for that object. | ||
| # - <tt>.rdoc</tt> (\RDoc markup text file) or <tt>.md</tt> (\RDoc markdown text file): |
There was a problem hiding this comment.
It seems like we're losing the information here that we generate docs from markdown files.
There was a problem hiding this comment.
My thinking is that this is the markup reference. I don't know whether a markup file can declare itself as markdown. But will restore if you like.
There was a problem hiding this comment.
Ah I see. Might be good to include it in a separate bullet point and make it clear that the rest of this guide doesn't apply since it's markdown. This section seems to list all of the sources that RDoc generates documentation from.
BurdetteLamar
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
peterzhu2118
approved these changes
Aug 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
In working on a markdown reference, I've noticed that the markup reference could use some work, too.
This adds some clarity to the intro, and has a couple of other small tweaks.
Much more to come.