Skip to content

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

Merged
onbjerg merged 1 commit into
foundry-rs:masterfrom
daixihegu:master
Aug 10, 2026
Merged

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

Conversation

@daixihegu

Copy link
Copy Markdown
Contributor

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

@daixihegu

Copy link
Copy Markdown
Contributor Author

@grandizzy @stevencartavia @DaniPopes Hi, Could you please review this PR at your convenience? Thank you very much.

Signed-off-by: daixihegu <daixihegu@163.com>
@onbjerg
onbjerg enabled auto-merge (squash) August 10, 2026 09:35
@onbjerg
onbjerg merged commit 467ffd4 into foundry-rs:master Aug 10, 2026
20 checks passed
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.

2 participants