Skip to content

Fix code examples in the documentation #3696

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
Merged
merged 2 commits into from
Jan 6, 2019
Merged

Fix code examples in the documentation #3696

merged 2 commits into from
Jan 6, 2019

Conversation

kroening
Copy link
Member

@kroening kroening commented Jan 6, 2019

To address issue #3566.

  • Each commit message has a non-empty body, explaining why the change was made.
  • n/a Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • n/a The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • n/a Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • n/a My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • n/a White-space or formatting changes outside the feature-related changed lines are in commits of their own.

@kroening kroening mentioned this pull request Jan 6, 2019
Closed
allredj
allredj reviewed Jan 6, 2019
View reviewed changes
Copy link
Contributor

@allredj allredj left a comment

Choose a reason for hiding this comment

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

✔️
Passed Diffblue compatibility checks (cbmc commit: b01fc03).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/96399483

tautschnig
tautschnig requested changes Jan 6, 2019
View reviewed changes
doc/cprover-manual/cbmc-tutorial.md Outdated
@@ -241,7 +241,7 @@ void unlock()
int main()
{
unsigned got_lock = 0;
int times;
int times = 10;
Copy link
Collaborator

Choose a reason for hiding this comment

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

This makes the loop bounded, and thus the example not longer fits what the section is about.

Copy link
Member Author

Choose a reason for hiding this comment

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

indeed, fixed

allredj
allredj reviewed Jan 6, 2019
View reviewed changes
Copy link
Contributor

@allredj allredj left a comment

Choose a reason for hiding this comment

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

✔️
Passed Diffblue compatibility checks (cbmc commit: d54d63b).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/96402158

@tautschnig tautschnig merged commit f57f2b8 into develop Jan 6, 2019
@tautschnig tautschnig deleted the fix-doc-examples branch January 6, 2019 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@allredj allredj allredj left review comments

@tautschnig tautschnig tautschnig approved these changes

@chrisr-diffblue chrisr-diffblue Awaiting requested review from chrisr-diffblue

@peterschrammel peterschrammel Awaiting requested review from peterschrammel peterschrammel is a code owner

@smowton smowton Awaiting requested review from smowton

Assignees

@kroening kroening

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kroening @tautschnig @allredj