Ignore @requires_ancestor in YardDoc listener
#2288
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
changed the title
@requires_ancestor in YardDoc listener@requires_ancestor in YardDoc listener
vinistock
approved these changes
May 26, 2025
Member
vinistock
left a comment
vinistock
left a comment
There was a problem hiding this comment.
Do we need to do it for other annotations on top of classes? E.g.: @interface, @abstract
Contributor
Author
Good question, I should have mentioned it in the description. YARD seems to pick up |
It's an RBS comment that will be translated in gem RBIs into a `requires_ancestor` call.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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
It's an RBS comment that will be translated in gem RBIs into a
requires_ancestorcall. We don't need it as part of documentation and it results in type checking errors.Implementation
Add it to the existing ignored comments list
Tests