[cleanup] improve comment alignment in gtlist.h#121784
Merged
tannergooding merged 3 commits intodotnet:mainfrom Dec 15, 2025
Merged
[cleanup] improve comment alignment in gtlist.h#121784tannergooding merged 3 commits intodotnet:mainfrom
tannergooding merged 3 commits intodotnet:mainfrom
Conversation
dotnet-policy-service
bot
added
the
community-contribution
github-actions
bot
added
the
needs-area-label
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the visual alignment of comments in gtlist.h by replacing comma-based placeholders with a clearer column alignment scheme using pipe characters (|) and arrows (v). The new format makes the comment structure more readable by explicitly showing the vertical alignment between the column headers and the actual GTNODE macro parameters.
Key Changes:
- Replaced floating commas in comments with explicit pipe characters (
|) to show column boundaries - Added arrows (
v) to clearly indicate which comment header corresponds to which macro parameter - Improved visual clarity while maintaining the same informational content
am11
added
area-CodeGen-coreclr
Contributor
|
Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch |
tannergooding
approved these changes
Dec 15, 2025
Member
|
cc. @dotnet/jit-contrib for secondary input |
adamperlin
approved these changes
Dec 15, 2025
Contributor
adamperlin
left a comment
adamperlin
left a comment
There was a problem hiding this comment.
I think this looks good to me. I agree that this is easier to parse visually!
This was referenced Jan 9, 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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This change improves the readability of comments in
gtlist.h.Previously, the comment columns were visually aligned by placing commas in the
same positions as the actual argument separators. While this kept the columns
technically aligned, the presence of "floating commas" in the comments made the
structure harder to parse at a glance.
The updated version replaces those comma placeholders with clearer alignment
cues, making the layout easier to understand.
No behavioral changes.
Part of #84834, cc @dotnet/samsung
@SkyShield @namu-lee