Skip to content

docs: clarify that solidity --snapshot-check is read-only #278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schaable merged 3 commits into from
Jul 2, 2026
Merged

docs: clarify that solidity --snapshot-check is read-only #278

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1b19f4
docs: clarify that solidity --snapshot-check is read-only
schaable Jun 13, 2026
960aa10
Potential fix for pull request finding
schaable Jun 13, 2026
444c5e7
docs: clarify that --snapshot-check fails when no snapshots exist
schaable Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/content/docs/docs/guides/testing/gas-snapshots.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,13 @@ Function gas snapshots: 1 changed
To update snapshots, run your tests with --snapshot
```

The check only fails when existing values change. Adding or removing test functions or cheatcode snapshot calls won't cause a failure.
The check only fails when existing values change, or when no snapshots exist yet and there's nothing to compare against. Adding or removing test functions or cheatcode snapshot calls won't cause a failure.

:::note

`--snapshot-check` only reads your snapshot files. It never creates, updates, or deletes them. Use `--snapshot` to update your snapshots.

:::

## Function gas snapshots

Expand Down
Loading