docs: add NatSpec @notice to public functions#860
Merged
zerosnacks merged 2 commits intoMay 13, 2026
Conversation
Adds @notice tags to all public-facing and internal functions enabling forge doc to autogenerate reference documentation for the Foundry Book. No function signatures or behavior changed.
mablr
requested review from
0xrusowsky,
DaniPopes,
grandizzy,
mattsse,
onbjerg and
zerosnacks
as code owners
- StdChains.getChain: document revert conditions - StdCheats.expectAndMockCall (gas overloads): clarify that gas only applies to the call expectation, not the mock - StdCheats.deployCodeTo: document vm.etch-based deployment semantics and constructor side-effect caveats - StdCheats.noGasMetering: note that nested usage only resumes metering at the outermost call - stdStorageSafe.findOffsets: document the returned 'found' bool - stdStorageSafe.read_bool: note the revert when value is not 0/1 - stdToml.serialize: clarify JSON-in-memory + TOML-on-write semantics Amp-Thread-ID: https://ampcode.com/threads/T-019e207d-61e2-7644-94cb-9a8861834bb5 Co-authored-by: Amp <amp@ampcode.com>
zerosnacks
approved these changes
May 13, 2026
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
3 participants
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.
Towards #653
Adds
@noticetags to all public-facing and internal functions enabling forge doc to autogenerate reference documentation for the Foundry Book. No function signatures or behavior changed.