Remove now unneeded rdoc private annotations - #4212
Merged
Merged
Conversation
RDoc 8 parses rbs (including inline) and so automatically removes the annotations for us
Earlopain
force-pushed
the
reduce-rdoc-private
branch
from
August 26, 2026 19:32
dfd511a to
9dcdafd
Compare
Earlopain
commented
Aug 26, 2026
| when /\A:/ | ||
| # skip RBS type annotations | ||
| # skip RBS type annotations and remove preceeding empty line | ||
| comments.pop if comments.last&.text&.empty? |
Collaborator
Author
There was a problem hiding this comment.
Hid an actual change here. It's just to keep rbi files as they are currently. Previously the line was removed because it was the private annotation (see above)
Collaborator
|
I get that it works now, but do we need to do this? It's a pretty large change. Is it better looking in the docs now if we remove the --? |
Collaborator
Author
|
It's only so large because of the generated rbi (don't know why rbs inline doesn't exclude its own type hints 🤷). It looks exactly the same in the docs. I don't want these in new code but if there're everywhere its just gonna get copy-pasted |
kddnewton
approved these changes
Aug 26, 2026
Collaborator
|
alrighty |
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
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.
RDoc 8 parses rbs (including inline) and so
automatically removes the annotations for us