Create doc checker system #1568
Open
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
When using RDoc's features, there are some mistakes that can easily be detected by RDoc itself, such as missing `rdoc-ref` targets. Currently RDoc only prints warnings to stdout. But to better notify users, it should exit the process with a non-zero status code. I plan to use this system to implement more checks in the future.
Collaborator
|
🚀 Preview deployment available at: https://899dfbea.rdoc-6cd.pages.dev (commit: 510dcbb) |
kou
reviewed
Jan 19, 2026
| # At the end of rdoc execution, if any warnings were added, they will be | ||
| # printed and the process will exit with status 1. | ||
|
|
||
| class RDoc::Checker |
Member
There was a problem hiding this comment.
If we don't instantiate this, we don't need to use class. module is better.
(And I think that we can improve name of this... This doesn't check anything. This just keeps reported warnings.)
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.
When using RDoc's features, there are some mistakes that can easily be detected by RDoc itself, such as missing
rdoc-reftargets.Currently RDoc only prints warnings to stdout. But to better notify users, it should exit the process with a non-zero status code.
I plan to use this system to implement more checks in the future.