Print warnings for rdoc-ref links that can't be resolved#1241
Merged
Conversation
2292340 to
cabeba5
Compare
This was referenced Dec 14, 2024
nobu
approved these changes
Dec 16, 2024
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Dec 16, 2024
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
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.
If
warn_missing_rdoc_refin.rdoc_optionsis specified totrue, or if--warn-missing-rdoc-refflag is used, then RDoc will print messages reminding the user that ardoc-ref:link could not be resolved.Some examples:
Unfortunately, due to the timing cross-reference happens, we can't get more detailed locations on the links. But I think we can improve it incrementally too.
ruby/ruby#12344 was discovered through this feature. There are around 50+ missing links in
ruby/rubyatm.Next Steps
ruby/rubyruby/rubyrdoc --detect-dead-rdoc-refor something similar so projects can run it on CI