Preserve sig parameter comments#612
Open
KaanOzkan wants to merge 4 commits into
Open
Conversation
KaanOzkan
force-pushed
the
ko-sig-param-rbs-comments
branch
3 times, most recently
from
1c12951 to
b24a431
Compare
KaanOzkan
commented
Jun 10, 2026
| params( | ||
| a: Integer, # `a` comment | ||
| b: String # `b` comment 1 | ||
| # `b` comment 2 |
Contributor
Author
There was a problem hiding this comment.
I opted to keep the existing RBI printer behaviour here so the comments are printed as trailing but we could also make it multiline like the RBS printer.
KaanOzkan
force-pushed
the
ko-sig-param-rbs-comments
branch
from
29b52dd to
15ffc31
Compare
KaanOzkan
force-pushed
the
ko-sig-param-rbs-comments
branch
from
15ffc31 to
11d51eb
Compare
KaanOzkan
force-pushed
the
ko-sig-param-rbs-comments
branch
from
11d51eb to
2e5d08d
Compare
Moves `node_comments` and comment parsing onto the shared parser visitor so `TreeBuilder` and `SigBuilder` consume the same comment map. This lets sig parameter parsing attach comments without leaving them behind as dangling node comments.
Attaches comments inside `params(...)` to the matching `RBI::SigParam` and makes `RBSPrinter` render printable param comments in multiline signatures. This keeps parameter documentation attached to the emitted RBS parameter line instead of floating above the method.
Extends the multiline RBS path to handle comments on block sig params, including overloads and generic block-only signatures. Comments are only printed when the block clause is emitted, so skipped `NilClass` block params do not leave detached comments or force multiline output.
Updates `rbi/rbi.rbi` after the parser and RBS printer changes.
KaanOzkan
force-pushed
the
ko-sig-param-rbs-comments
branch
from
2e5d08d to
43ea118
Compare
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
1 participant
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.
To be used by Shopify/spoom#901