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

Documentation: Workarounds (new section) #1005

Merged

Conversation

adpaco-aws
Copy link
Contributor

Description of changes:

Adds a new "Workarounds" section to "Developer documentation". The sections focuses on CBMC arguments and individual loop bounds, which are removed from earlier sections.

Resolved issues:

Part of #700

Call-outs:

Testing:

  • How is this change tested? N/A

  • Is this a refactor change? No.

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@adpaco-aws adpaco-aws requested a review from a team as a code owner April 1, 2022 21:02
Copy link
Contributor

@zhassan-aws zhassan-aws 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.

docs/src/workarounds.md Outdated Show resolved Hide resolved
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
@adpaco-aws adpaco-aws merged commit 8f4cee3 into model-checking:main Apr 1, 2022
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 22, 2022
* Documentation: Workarounds (new section)

* Update docs/src/workarounds.md

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 25, 2022
* Documentation: Workarounds (new section)

* Update docs/src/workarounds.md

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 26, 2022
* Documentation: Workarounds (new section)

* Update docs/src/workarounds.md

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
tedinski pushed a commit that referenced this pull request Apr 27, 2022
* Documentation: Workarounds (new section)

* Update docs/src/workarounds.md

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>

Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
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.

2 participants