Skip to content

docs: fix duplicate words and 'subwrod' typos in cannon NatSpec#274

Open
0xAxiom wants to merge 1 commit into
base:mainfrom
0xAxiom:fix/natspec-duplicate-words
Open

docs: fix duplicate words and 'subwrod' typos in cannon NatSpec#274
0xAxiom wants to merge 1 commit into
base:mainfrom
0xAxiom:fix/natspec-duplicate-words

Conversation

@0xAxiom
Copy link
Copy Markdown

@0xAxiom 0xAxiom commented May 10, 2026

Summary

Comment/NatSpec-only fixes for typos that have been sitting in the cannon files since their introduction (Feb 22 commit 27731f5):

  • `src/cannon/MIPS64.sol` — `loadSubWord` NatSpec: `the the subword` → `the subword`; `subwrod` → `subword`
  • `src/cannon/libraries/MIPS64Instructions.sol` — `selectSubWord` NatSpec: `the the subword` → `the subword`; `subwrod` → `subword`
  • `scripts/deploy/DeployOPChain.s.sol` — inline comment: `because to to update` → `because to update`
- /// @param _vaddr The virtual address of the the subword.
+ /// @param _vaddr The virtual address of the subword.
- /// @param _signExtend Whether to sign extend the selected subwrod.
+ /// @param _signExtend Whether to sign extend the selected subword.
- // because to to update to the permissionless game, we will need to update its starting
+ // because to update to the permissionless game, we will need to update its starting

No behavior change — strings/identifiers/Solidity code are untouched, only NatSpec and inline comments.

GPG-signed.

- src/cannon/MIPS64.sol: 'the the subword' -> 'the subword'; 'subwrod' -> 'subword' in loadSubWord NatSpec
- src/cannon/libraries/MIPS64Instructions.sol: 'the the subword' -> 'the subword'; 'subwrod' -> 'subword' in selectSubWord NatSpec
- scripts/deploy/DeployOPChain.s.sol: 'because to to update' -> 'because to update' in inline comment

Comment-only changes; no behavior change.
@cb-heimdall
Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants