-
Notifications
You must be signed in to change notification settings - Fork 234
Update rdoc to 6.13.1 #2355
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update rdoc to 6.13.1 #2355
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4abfb82
Limit to 6.13 or higher
ksss eac4738
`RDoc::Store.new` interface has been changed.
ksss d094e76
Return value of `RDoc::Attr#comment` has been changed.
ksss c3f79e9
CodeObject method interface has been changed
ksss 60b480c
Add doc
ksss 484c4e1
Simplify object variation
ksss f4ee1d9
Update rdoc to 6.13.1
ksss e5f3933
Merge remote-tracking branch 'upstream/master' into update-rdoc
ksss a9af5c1
Use `gem` instead of runtime dependency
ksss File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| %a{annotate:rdoc:skip} | ||
| module RDoc | ||
| # <!-- rdoc-file=lib/rdoc/options.rb --> | ||
| # RDoc::Options handles the parsing and storage of options | ||
| # | ||
| # ## Saved Options | ||
| # | ||
| # You can save some options like the markup format in the `.rdoc_options` file | ||
| # in your gem. The easiest way to do this is: | ||
| # | ||
| # rdoc --markup tomdoc --write-options | ||
| # | ||
| # Which will automatically create the file and fill it with the options you | ||
| # specified. | ||
| # | ||
| # The following options will not be saved since they interfere with the user's | ||
| # preferences or with the normal operation of RDoc: | ||
| # | ||
| # * `--coverage-report` | ||
| # * `--dry-run` | ||
| # * `--encoding` | ||
| # * `--force-update` | ||
| # * `--format` | ||
| # * `--pipe` | ||
| # * `--quiet` | ||
| # * `--template` | ||
| # * `--verbose` | ||
| # | ||
| # ## Custom Options | ||
| # | ||
| # Generators can hook into RDoc::Options to add generator-specific command line | ||
| # options. | ||
| # | ||
| # When `--format` is encountered in ARGV, RDoc calls ::setup_options on the | ||
| # generator class to add extra options to the option parser. Options for custom | ||
| # generators must occur after `--format`. `rdoc --help` will list options for | ||
| # all installed generators. | ||
| # | ||
| # Example: | ||
| # | ||
| # class RDoc::Generator::Spellcheck | ||
| # RDoc::RDoc.add_generator self | ||
| # | ||
| # def self.setup_options rdoc_options | ||
| # op = rdoc_options.option_parser | ||
| # | ||
| # op.on('--spell-dictionary DICTIONARY', | ||
| # RDoc::Options::Path) do |dictionary| | ||
| # rdoc_options.spell_dictionary = dictionary | ||
| # end | ||
| # end | ||
| # end | ||
| # | ||
| # Of course, RDoc::Options does not respond to `spell_dictionary` by default so | ||
| # you will need to add it: | ||
| # | ||
| # class RDoc::Options | ||
| # | ||
| # ## | ||
| # # The spell dictionary used by the spell-checking plugin. | ||
| # | ||
| # attr_accessor :spell_dictionary | ||
| # | ||
| # end | ||
| # | ||
| # ## Option Validators | ||
| # | ||
| # OptionParser validators will validate and cast user input values. In addition | ||
| # to the validators that ship with OptionParser (String, Integer, Float, | ||
| # TrueClass, FalseClass, Array, Regexp, Date, Time, URI, etc.), RDoc::Options | ||
| # adds Path, PathArray and Template. | ||
| # | ||
| class Options | ||
| def initialize: (?untyped loaded_options) -> void | ||
| end | ||
| end |
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the test code
RBS::Annotate::Formatter.translate(something.comment)should be fixed instead of accepting comment here.def self.each_part(in line 60) can be also simplified.def self.each_part(doc, &block) if block - document = - case doc - when String - raise - when RDoc::Comment - document = doc.parse - when RDoc::Markup::Document - document = doc - end + document = doc - Formatter.each_part(subject.comment) do |doc| + raise if subject.comment.is_a?(String) + Formatter.each_part(subject.comment.parse) do |doc|With some type modification
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!