Skip RBS comments in YardDoc listener #2310
Merged
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
KaanOzkan
force-pushed
the
ko/yard-doc-rbs
branch
from
704c7bb to
2c0bd92
Compare
KaanOzkan
commented
Jun 4, 2025
| "shareable_constant_value:", | ||
| "rubocop:", | ||
| "@requires_ancestor:", | ||
| ": ", |
Contributor
Author
There was a problem hiding this comment.
This is used with an include? call down below. I want to make sure I'm not ignoring more comments than necessary so added the space. But it's not perfect.
Contributor
There was a problem hiding this comment.
I think prefer a fully fledge rbs_comment? method we call from documentation_comments.
Or at least a comment explaining what is this : :
Suggested change
| ": ", | |
| ": ", # ignore RBS signature comments |
KaanOzkan
force-pushed
the
ko/yard-doc-rbs
branch
from
2c0bd92 to
c0659f6
Compare
YardDoc listener thinks they are method comments and adds it to the RBI when they are already translated to sigs.
KaanOzkan
force-pushed
the
ko/yard-doc-rbs
branch
from
c0659f6 to
bd0a552
Compare
st0012
approved these changes
Jun 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation
YardDoc listener thinks they are method comments and adds it to the RBI when they are already translated to sigs.
Implementation
I'm trying to naively identify RBS comments through
:and|Tests