docs(StdAssertions, StdInvariant): add NatSpec for public functions#837
Merged
zerosnacks merged 1 commit intofoundry-rs:masterfrom Mar 26, 2026
Merged
Conversation
Ra9huvansh
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
2 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.
Adds NatSpec documentation to all public and internal functions in
StdAssertions.solandStdInvariant.solas part of #653.Changes:
@noticeto every function describing its behavior@paramfor all parameters@returnfor functions with return values@devfor legacy/backwards-compatibility context@noticefor both contracts@dev-only comments with@notice+@param/@returnin StdInvariant.solNo logic, interface, or code changes. Comment-only additions.