Fix comment indentation #143
Merged
Conversation
This file contains 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
Before this change, the parser would default to setting the level of comments to the level of the current context, making an exception for comments inside a 'subroutine' or 'type block' context. This exception allows some comments to inherit the level of the next line. This change fixes an issue where only the last comment in a series would have this exception applied, and also flips the default handling so that this 'exception' is actually the norm. Usually, comments are 'supposed' to relate to what they precede, so we should try to set the level of the comment to the next 'thing'. However in some cases this makes little sense, because the next 'thing' may be a token that only exists to end a block context (e.g. 'end'). So the new exception is for comments in 'statement list' contexts to have the level of the context, but everything else has the level of the next line.
zaneduffield
commented
Feb 18, 2025
jgardn3r
approved these changes
Feb 18, 2025
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.
Before this change, the parser would default to setting the level of
comments to the level of the current context, making an exception for
comments inside a 'subroutine' or 'type block' context. This exception
allows some comments to inherit the level of the next line.
This change fixes an issue where only the last comment in a series
would have this exception applied, and also flips the default handling
so that this 'exception' is actually the norm.
Usually, comments are 'supposed' to relate to what they precede, so we
should try to set the level of the comment to the next 'thing'. However
in some cases this makes little sense, because the next 'thing' may be a
token that only exists to end a block context (e.g. 'end'). So the new
exception is for comments in 'statement list' contexts to have the level
of the context, but everything else has the level of the next line.