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.

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

Jump to bottom

DOC-308: Documentation for conf file #134

Merged
merged 68 commits into from
Jan 11, 2024
Merged

DOC-308: Documentation for conf file #134

merged 68 commits into from
Jan 11, 2024

Conversation

rahav-certora
Copy link
Contributor

@rahav-certora rahav-certora commented Aug 22, 2023 •
edited by mdgeorge4153
Loading

Links to generated documentation:

@rahav-certora rahav-certora self-assigned this Aug 22, 2023
@rahav-certora rahav-certora requested a review from a team as a code owner August 22, 2023 11:33
@rahav-certora rahav-certora changed the title Documentation for conf file DOC-308: Documentation for conf file Aug 22, 2023
chandrakananandi
chandrakananandi requested changes Aug 22, 2023
View reviewed changes
Copy link
Contributor

@chandrakananandi chandrakananandi left a comment

Choose a reason for hiding this comment

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

Thanks for putting this together! I think it would be good to make it more complete. Maybe a table mapping the CLI flag names to their corresponding json field names? I recall some were not obvious.

docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Show resolved Hide resolved
@chandrakananandi chandrakananandi self-requested a review August 23, 2023 19:40
chandrakananandi
chandrakananandi approved these changes Aug 23, 2023
View reviewed changes
Copy link
Contributor

@chandrakananandi chandrakananandi left a comment

Choose a reason for hiding this comment

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

Thanks for this PR!

shellygr
shellygr reviewed Aug 29, 2023
View reviewed changes
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
mdgeorge4153
mdgeorge4153 suggested changes Aug 29, 2023
View reviewed changes
Copy link
Contributor

@mdgeorge4153 mdgeorge4153 left a comment

Choose a reason for hiding this comment

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

Looks good. I left several comments; let me know if you want to make an editing pass.

docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
docs/prover/cli/conf-file-api.md Outdated Show resolved Hide resolved
@mdgeorge4153 mdgeorge4153 self-requested a review September 25, 2023 21:01
rahav-certora and others added 29 commits January 10, 2024 18:15
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
45bcdf3 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
64fedaa 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
3d91b32 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
eb99063 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
8c7e90d 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
ca6e80c 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
d810aeb 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
e944fda 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
82b0b58 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
ff2bbe9 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
177cf9e 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
21bceee 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
05678f3 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
eacc988 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
f7ac815 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
4fce2ca 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
b326d35 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
8797697 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
37b8ebe 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
06eac96 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
286a0b1 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/conf-file-api.md
45c3d9e 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora @mdgeorge4153
Update docs/prover/cli/options.md
15b7d34 
Co-authored-by: Michael D. George <[email protected]>
@rahav-certora
Mike's comments
5e56ec2
@rahav-certora
merge
93aca46
@rahav-certora
fix
7d58aae
@rahav-certora
fix
f53c9aa
@rahav-certora
fix
6185a92
@rahav-certora
fix
a5bc9ff
@rahav-certora rahav-certora merged commit 9ebc9fa into master Jan 11, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chandrakananandi chandrakananandi chandrakananandi approved these changes

@shellygr shellygr shellygr approved these changes

@mdgeorge4153 mdgeorge4153 mdgeorge4153 approved these changes

Assignees

@rahav-certora rahav-certora

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rahav-certora @mdgeorge4153 @shellygr @chandrakananandi