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

Add documentation to loop contracts, __CPROVER_loop_entry #8377

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

QinyuanWu
Copy link

  • [ x] Each commit message has a non-empty body, explaining why the change was made.
  • [ x] My PR is restricted to a single feature or bugfix.

This PR is documentation only.

Copy link
Collaborator

@tautschnig tautschnig left a comment

Choose a reason for hiding this comment

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

Thank you for adding documentation!

Copy link

codecov bot commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.32%. Comparing base (629dbcd) to head (59646b3).
Report is 6 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8377      +/-   ##
===========================================
- Coverage    78.35%   78.32%   -0.03%     
===========================================
  Files         1726     1726              
  Lines       188424   188506      +82     
  Branches     18248    18249       +1     
===========================================
+ Hits        147631   147646      +15     
- Misses       40793    40860      +67     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@qinheping qinheping left a comment

Choose a reason for hiding this comment

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

It looks pretty good. Thank you!

@QinyuanWu
Copy link
Author

QinyuanWu commented Jul 15, 2024

@qinheping I added a nested loop example to the loop contract documentation to explain the havoc nature of the assigns clause. Could you please take a look to make sure everything is accurate?

@QinyuanWu QinyuanWu requested a review from qinheping July 15, 2024 19:05
@QinyuanWu
Copy link
Author

All suggestions have been resolved. @tautschnig @qinheping Please approve this PR if everything looks good! ^_^

Copy link
Collaborator

@qinheping qinheping left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@tautschnig tautschnig left a comment

Choose a reason for hiding this comment

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

Please combine your commits into a single one.

…try_old

add loop contract example

emphasize size in bytes

document assign clause for nested loop

Apply suggestions from code review

Co-authored-by: Michael Tautschnig <[email protected]>

Apply suggestions from code review

Co-authored-by: Qinheping Hu <[email protected]>

add nested loop example

Apply suggestions from code review

Co-authored-by: Qinheping Hu <[email protected]>

modify comments in nested loop example
@QinyuanWu
Copy link
Author

Please combine your commits into a single one.

Commits squashed.

@tautschnig tautschnig merged commit 82bbeb8 into diffblue:develop Jul 16, 2024
38 of 40 checks passed
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

Successfully merging this pull request may close these issues.

3 participants