docs: add NatSpec to Script and Test base contracts#880
Open
daixihegu wants to merge 1 commit into
Open
Conversation
Signed-off-by: daixihegu <daixihegu@163.com>
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
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
ScriptandTestbase contracts.IS_SCRIPTandIS_TESTmarker getters.Motivation
This continues the NatSpec coverage work tracked in #653.
Script.solandTest.solare still listed as missing public-facing NatSpec coverage, and documenting them helps generated forge-std reference docs include the default base contracts and their marker getters.Part of #653.
Testing
forge fmt --check src/Script.sol src/Test.solforge buildforge test --no-match-contract ConfigTest -vvvgit diff --check