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

Docs: Fix showProvedSafe flag and JSON key name #15304

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

ardislu
Copy link
Contributor

@ardislu ardislu commented Jul 27, 2024

Currently, the "SMTChecker and Formal Verification" documentation page says:

Proved Targets

If there are any proved targets, the SMTChecker issues one warning per engine stating how many targets were proved. If the user wishes to see all the specific proved targets, the CLI option --model-checker-show-proved and the JSON option settings.modelChecker.showProved = true can be used.

However, the correct CLI flag is --model-checker-show-proved-safe and the correct JSON key is showProvedSafe.

This PR updates the documentation to reflect the correct flag and JSON key.

Interestingly, the commit that introduced this mistake used the correct flag/key in the changelog but not the docs for some reason.

Copy link

Thank you for your contribution to the Solidity compiler! A team member will follow up shortly.

If you haven't read our contributing guidelines and our review checklist before, please do it now, this makes the reviewing process and accepting your contribution smoother.

If you have any questions or need our help, feel free to post them in the PR or talk to us directly on the #solidity-dev channel on Matrix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant