Skip to content

docs(symbolic): improve documentation#15098

Merged
grandizzy merged 1 commit into
foundry-rs:masterfrom
figtracer:fig/symbolic-docs
Jun 8, 2026
Merged

docs(symbolic): improve documentation#15098
grandizzy merged 1 commit into
foundry-rs:masterfrom
figtracer:fig/symbolic-docs

Conversation

@figtracer

@figtracer figtracer commented Jun 8, 2026

Copy link
Copy Markdown
Member

Summary

  • clarify symbolic testing's current MVP scope and what a PASS means
  • document --match-test vs --match-contract for check* / prove* entrypoints
  • add troubleshooting for No tests found, surprising PASS, and Incomplete outcomes
  • link the community symbolic bug suite as capability examples, not a full audit claim

@figtracer figtracer force-pushed the fig/symbolic-docs branch 3 times, most recently from 00f46bd to 366c574 Compare June 8, 2026 09:39
@figtracer figtracer force-pushed the fig/symbolic-docs branch from 366c574 to c3f8571 Compare June 8, 2026 09:50
@figtracer figtracer marked this pull request as ready for review June 8, 2026 09:52
@figtracer figtracer changed the title docs(symbolic): clarify MVP scope and troubleshooting docs(symbolic): improve documentation Jun 8, 2026
Comment on lines +49 to +54
`--match-test` filters function names or signatures. To filter by contract, use
`--match-contract`:

```sh
forge test --symbolic --match-test check_average
forge test --symbolic --match-contract MathSymbolicTest

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unsure we need this, this is the default everywhere

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not needed imo, but doesn't hurt

@grandizzy grandizzy merged commit 745e96c into foundry-rs:master Jun 8, 2026
19 checks passed
@github-project-automation github-project-automation Bot moved this to Done in Foundry Jun 8, 2026
@figtracer figtracer deleted the fig/symbolic-docs branch June 8, 2026 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants