Skip to content

docs: add NatSpec to Script and Test base contracts#880

Open
daixihegu wants to merge 1 commit into
foundry-rs:masterfrom
daixihegu:master
Open

docs: add NatSpec to Script and Test base contracts#880
daixihegu wants to merge 1 commit into
foundry-rs:masterfrom
daixihegu:master

Conversation

@daixihegu

Copy link
Copy Markdown

Summary

  • Add NatSpec to the Script and Test base contracts.
  • Document the IS_SCRIPT and IS_TEST marker getters.
  • Keep the change documentation-only with no behavior changes.

Motivation

This continues the NatSpec coverage work tracked in #653. Script.sol and Test.sol are 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.sol
  • forge build
  • forge test --no-match-contract ConfigTest -vvv
  • git diff --check

Signed-off-by: daixihegu <daixihegu@163.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant