docs(audit): close ~44 LOW NatSpec / contract-doc findings in one sweep#229
docs(audit): close ~44 LOW NatSpec / contract-doc findings in one sweep#229hardyjosh wants to merge 1 commit into
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1bbd3aa to
2fdbd5b
Compare
83e9695 to
3ac8021
Compare
2fdbd5b to
bdcab6f
Compare
3ac8021 to
bf9e11e
Compare
bdcab6f to
b023f80
Compare
bf9e11e to
c6e2975
Compare
b023f80 to
6d10a1d
Compare
Bundles the documentation-only LOW audit findings: - 9 events get @notice + @param per parameter (was @dev only) - 5 ICloneableV2 typed-overload initialisers get full NatSpec - 4 setters / view functions get missing @param - 9 contract/function NatSpec blocks rewritten to match actual behaviour - 3 error definitions get better param names and docs - 4 LibProdDeploy constants get per-constant role docs - 1 setAdmin block gets a one-step-transfer lockout warning - 1 PassthroughProtocolAdapter PRECONDITION on registered-oracle decimals - 2 BeaconSetDeployer @param admin docs expand on conferred authority - 3 AGENTS.md / CLAUDE.md process-doc refinements - 3 SPEC.md drift fixes (§9 newOracleRegistry signature, §10 example call, §10 returns) No executable code or test changes. nix CI green (test/static/legal). Closes #30, #31, #32, #78, #79, #80, #84, #88, #92, #93, #95, #96, #97, #98, #99, #100, #101, #102, #103, #104, #105, #120, #147, #157, #160, #161, #165, #166, #167, #169, #170, #174, #178, #182, #189, #190, #191, #192, #202, #204, #211, #217, #219. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
173b4a3 to
7a76b2b
Compare
6d10a1d to
536621f
Compare
|
Deferred for Euler launch. Pure-docs sweep across 44 LOW NatSpec issues; addresses no functional concern. |

Bundles the documentation-only LOW audit findings:
No executable code or test changes. nix CI green (test/static/legal).
Closes #30, #31, #32, #78, #79, #80, #84, #88, #92, #93, #95, #96, #97, #98, #99, #100, #101, #102, #103, #104, #105, #120, #147, #157, #160, #161, #165, #166, #167, #169, #170, #174, #178, #182, #189, #190, #191, #192, #202, #204, #211, #217, #219.
Co-Authored-By: Claude Opus 4.7 noreply@anthropic.com