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

Consistency in documentation and terminal #34

Open
reekamaharaj opened this issue Jan 23, 2024 · 0 comments
Open

Consistency in documentation and terminal #34

reekamaharaj opened this issue Jan 23, 2024 · 0 comments

Comments

@reekamaharaj
Copy link
Contributor

Kontrol Cheatsheet

Further note: With the intention of keeping the docs consistent I added the SMT tactic flag like this:
--smt-tactic $smt_tactic

I used this to match what we have in the docs right now. The cheatsheet has the flags documented like this: --bmc-depth $n

Showing that $n is something the user will set. This is slightly different than what is in the terminal when you run kontrol prove -h there you will see --bmc-depth BMC_DEPTH (@JuanCoRo tell me if this is wrong.)

We might want to discuss which way to use. The docs should match what shows up in the terminal when you use --help

Personally the way Juan did it by adding $ makes sense to me. I immediately realized that it was something like a variable that the user would set. It also is what is used on the kup cheatsheet page. So its consistent on the docs side at the moment.

Originally posted by @reekamaharaj in #30 (comment)

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

No branches or pull requests

1 participant