Update RBS comments imported from RDoc #881
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
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.
I'd like to add
rbs annotatecommand to sync RDoc comments in RBS files. A single command$ rbs annotate core stdlibwill synchronize the RBS comments with RDoc.This can be done with three RBS annotations.
annotate:rdoc:skipis to skip annotating modules. This is typically for adding methods to existing modules/classes.annotate:rdoc:source:from=PATHis to remove RDoc comments selectively based on the source file name. This is also for supplemental documents for extending existing modules/classes.annotate:rdoc:copy:SOURCEis to copy a document from some method/class.