Fix rubygems hook execution when gemspec.rdoc_options contains --ri #1347
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
`finish` should be called before `rdoc.parse_files(options.files)`. `finish` should be called after `options.setup_generator`. We need to use a different RDoc::Options object for parse_files phase and document generation phase.
kou
approved these changes
Apr 23, 2025
|
|
||
| say "Parsing documentation for #{@spec.full_name}" | ||
|
|
||
| Dir.chdir @spec.full_gem_path do | ||
| @rdoc.parse_files options.files | ||
| parse_options = options.dup |
There was a problem hiding this comment.
How about adding a comment why we need to create a separated options here?
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.
Probably fixes #1343
options.finishis called twice while generating document through rubygems_hook.If gemspec has
spec.rdoc_options << '--ri', document generation fails.Looks like this double-finish is introduced in #1274
Detail of the bug
Fix
Constraints are:
finishshould be called beforerdoc.parse_files(options.files)finishshould be called afteroptions.setup_generatorrdoc.parse_filesonly onceWe need to use a different RDoc::Options object for parse_files phase and document generation phase.