Skip to content

MASM lowercase inline comments#2398

Merged
mmagician merged 3 commits intonextfrom
mmagician-cursor-masm-file-compliance-check-eefd
Feb 6, 2026
Merged

MASM lowercase inline comments#2398
mmagician merged 3 commits intonextfrom
mmagician-cursor-masm-file-compliance-check-eefd

Conversation

@mmagician
Copy link
Copy Markdown
Collaborator

@mmagician mmagician commented Feb 4, 2026

Fix MASM inline comment casing to adhere to convention.

This PR addresses MASM commenting conventions by converting the first letter of inline comments (prefixed with #) to lowercase.

Comments preceding section headers (lines with # -----) were intentionally excluded from this change.


Open in Cursor Open in Web

@cursor
Copy link
Copy Markdown

cursor bot commented Feb 4, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@mmagician mmagician changed the title Masm file compliance check MASM lowercase inline comments Feb 4, 2026
@mmagician mmagician added the documentation Improvements or additions to documentation label Feb 4, 2026
@mmagician mmagician marked this pull request as ready for review February 4, 2026 13:02
cursoragent and others added 2 commits February 4, 2026 13:03
- output_note.masm: lowercase 'check' and 'store' comments
- memory.masm: lowercase 'for', 'if', and 'we' comments
- bridge_in.masm: lowercase 'push' and 'check' comments

Section header comments (preceding lines with # -----) are left uppercase as intended.

Co-authored-by: marti <marti@hungrycats.studio>
Co-authored-by: marti <marti@hungrycats.studio>
@mmagician mmagician force-pushed the mmagician-cursor-masm-file-compliance-check-eefd branch from 67001ad to e231073 Compare February 4, 2026 13:03
Copy link
Copy Markdown
Contributor

@PhilippGackstatter PhilippGackstatter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I would actually prefer if these were uppercase, which would be more in line with english grammar and doc comments. It's pretty awkward to write comments with multiple sentences where I'm never sure whether to start the second sentence lower or uppercase, as both violate either grammar or masm conventions 😅

@mmagician mmagician merged commit 17e40ac into next Feb 6, 2026
17 checks passed
@mmagician mmagician deleted the mmagician-cursor-masm-file-compliance-check-eefd branch February 6, 2026 08:34
afa7789 pushed a commit to afa7789/miden-base that referenced this pull request Mar 9, 2026
…le-compliance-check-eefd

MASM lowercase inline comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants