Add tools/rdoc-to-md script #50870
Merged
Add tools/rdoc-to-md script #50870
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
Generally the idea is: - use Prism to parse the file into AST + Comments - transform each comment block into plain RDoc (instead of RDoc in a comment) - use RDoc's ToMarkdown class to get a Markdown representation of the comment - transform the Markdown representation back into a comment - write a new file, skipping the lines that were previously RDoc comments and instead inserting the new Markdown comments A little extra work has to be down for metaprogrammed documentation because ToMarkdown turns RDoc directives into H1s. So for these cases, the directive is first split off the top before doing the ToMarkdown transformation and then added back afterwards.
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.
Ref #50759
Generally the idea is:
comment)
comment
comments and instead inserting the new Markdown comments
A little extra work has to be down for metaprogrammed documentation
because ToMarkdown turns RDoc directives into H1s. So for these cases,
the directive is first split off the top before doing the ToMarkdown
transformation and then added back afterwards.