fix: correct NatSpec tags, typo, and parameter naming#287
Open
memosr wants to merge 1 commit into
Open
Conversation
Three small but real fixes in dispute-game and system config contracts: 1. FaultDisputeGameV2.sol (line 567) and PermissionedDisputeGameV2.sol (line 52) — Change @notice to @param for the _disputed parameter. The wrong tag means NatSpec tooling renders the parameter as undocumented and treats the description as a stray contract notice. 2. FaultDisputeGameV2.sol (line 575) — Fix backtick-wrapped type reference PreimageOralce → PreimageOracle. 3. SystemConfig.sol (lines 479-482) — Rename internal function parameter _dAFootprintGasScalar → _daFootprintGasScalar to match the public wrapper, the storage variable, and the NatSpec @param tag at line 473.
Collaborator
🟡 Heimdall Review Status
|
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.
Summary
Three small but real fixes across dispute game and system config contracts.
Changes
1.
@notice→@paramfor_disputedparameter (2 files)The wrong tag type means NatSpec tooling (forge doc, etherscan) renders these parameters as undocumented while the description shows up as a stray contract notice.
src/L1/proofs/v2/FaultDisputeGameV2.sol(line 567,defend()):src/L1/proofs/v2/PermissionedDisputeGameV2.sol(line 52,move()):The sibling
attack()function already uses the correct@param _disputedtag, making the inconsistency obvious.2. Typo:
PreimageOralce→PreimageOraclesrc/L1/proofs/v2/FaultDisputeGameV2.sol(line 575):The contract name is misspelled in a backtick-wrapped type reference, which would render as a broken link in generated docs.
3. Parameter naming:
_dAFootprintGasScalar→_daFootprintGasScalarsrc/L1/SystemConfig.sol(lines 479-482):The "DA" abbreviation should be a single lowercase prefix in camelCase. The public wrapper, the storage variable (
daFootprintGasScalar), and the NatSpec@paramtag at line 473 all use the lowercase-a form. This was likely a copy-paste error where "DA" was typed as two separate letters.Verification