docs: add NatSpec to Base.sol (CommonBase / TestBase / ScriptBase)#863
Open
js360000 wants to merge 1 commit into
Open
docs: add NatSpec to Base.sol (CommonBase / TestBase / ScriptBase)#863js360000 wants to merge 1 commit into
js360000 wants to merge 1 commit into
Conversation
Documents the contracts and their constants in Base.sol with `@notice` tags while preserving the existing `@dev` calculation notes. Covers the two previously undocumented members (`UINT256_MAX`, `vm`, `stdstore`, `vmSafe`) and adds contract-level `@notice` blocks. Part of foundry-rs#653.
js360000
requested review from
0xrusowsky,
DaniPopes,
grandizzy,
mattsse,
onbjerg and
zerosnacks
as code owners
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
1 participant
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
Adds NatSpec
@noticetags to the three base contracts (CommonBase,TestBase,ScriptBase) and to their previously-undocumented members (UINT256_MAX,vm,stdstore,vmSafe), while preserving the existing@devcalculation notes on the address constants.Part of #653.
Test plan
forge buildpasses locally (Solc 0.8.29).forge fmt --check src/Base.solis clean.