Add NatSpec for StdMath and StdUtils#830
Open
esorense wants to merge 1 commit intofoundry-rs:masterfrom
Open
Conversation
esorense
requested review from
0xrusowsky,
DaniPopes,
grandizzy,
klkvr,
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.
This PR adds missing NatSpec to
stdMathand keyStdUtilshelpers (bound,boundPrivateKey,bytesToUint,computeCreate*,hashInitCode, andgetTokenBalances).This is needed because these widely used utility APIs were under-documented, and
boundsemantics are easy to misread without explicit wording. The updated comments now clearly describe the real behavior (including wrap-into-range behavior and deprecation notes).Correctness is low-risk and verifiable: this is comment-only, with no logic, signature, or behavior changes. The annotations were written directly from the current implementation and existing revert conditions.