Repository navigation
Allow commented multiline type alias - #1044
Merged
Merged
Conversation
Morriar
approved these changes
Oct 28, 2026
KaanOzkan
reviewed
Oct 28, 2026
| #: type header = Hash[ | ||
| #| String, # the name | ||
| #| String, # the value | ||
| #| ] |
Contributor
There was a problem hiding this comment.
Don't we want the comments to survive after translation?
Member
Author
There was a problem hiding this comment.
I was mostly concerned with the rewrite being valid, but your point is fair we should preserve the comments.
The latest commit preserves them, but there's one caveat: they are place above the type instead of as a trailing comment.
We can definitely do the more sophisticated version of this, but it requires more refactors because, at the moment, there's no easy way to associate each line's comment with part of a type (i.e.: the alias is a single Type that spans across multiple lines).
vinistock
force-pushed
the
vs_allow_commented_multiline_alias
branch
from
October 28, 2026 20:16
9db232c to
26ea68c
Compare
KaanOzkan
approved these changes
Oct 29, 2026
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
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.
We have a few cases of type aliases where the specific parts are documented. For example:
Translating these to RBS type checks properly, but Spoom incorrectly rewrites them from RBS to sig. We should fix this because not supporting these trailing comments make it quite weird to document specific parts of the aliases since there are no names to "attach" the comment to. For example:
This PR fixes the rewriting to allow for commented multiline type aliases.