Skip to content
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.

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

Document reasoning behind vm.expectRevert error and when it is safe #1417

Open
zerosnacks opened this issue Feb 1, 2025 · 0 comments
Open
Assignees
Labels
T-enhancement Type: enhance existing docs

Comments

@zerosnacks
Copy link
Member

We should not refer to it as strongly discouraged but explain the implications in the docs and how it is a footgun.

One model of reference is the "memory-safe" annotation. If you annotate (i.e. allow internal reverts), you should understand what you’re doing, otherwise it can lead to undefined behaviour.

In short, heavier on content and less on the warning

@zerosnacks zerosnacks added the T-enhancement Type: enhance existing docs label Feb 1, 2025
@zerosnacks zerosnacks self-assigned this Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-enhancement Type: enhance existing docs
Projects
No open projects
Status: No status
Development

No branches or pull requests

1 participant