chore: keep MASM inline comments to what the code does - #3800
Merged
Conversation
Extends rule 6 of the masm-inline-comments skill: an inline comment is one line about what the next block does or which invariant it relies on, not design rationale, PR-review reasoning, or a justification of step ordering, which belong in the procedure's doc comment. Prompted by review on #3798, where such prose had to be trimmed by hand. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KkQzFtRjyDwQ7iVtRbsHsn
zeapoz
approved these changes
Sep 3, 2026
zeapoz
left a comment
Collaborator
There was a problem hiding this comment.
Looks good to me and good call!
Co-authored-by: zeapoz <zeapo@pm.me>
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.
Extends rule 6 of the
masm-inline-commentsskill: an inline comment is one line about what the next block does or which invariant it relies on, not design rationale, PR-review reasoning, or a justification of step ordering.