Update Unwind documentation #1087
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adpaco-aws
previously requested changes
Apr 21, 2022
Co-authored-by: Adrian Palacios <73246657+adpaco-aws@users.noreply.github.com>
tedinski
reviewed
Apr 21, 2022
…wind-documentation-update
…nan/kani into unwind-documentation-update
tedinski
approved these changes
Apr 21, 2022
tedinski
pushed a commit
to tedinski/rmc
that referenced
this pull request
Apr 22, 2022
* update unwind documentation Co-authored-by: Adrian Palacios <73246657+adpaco-aws@users.noreply.github.com>
tedinski
pushed a commit
to tedinski/rmc
that referenced
this pull request
Apr 25, 2022
* update unwind documentation Co-authored-by: Adrian Palacios <73246657+adpaco-aws@users.noreply.github.com>
tedinski
pushed a commit
to tedinski/rmc
that referenced
this pull request
Apr 26, 2022
* update unwind documentation Co-authored-by: Adrian Palacios <73246657+adpaco-aws@users.noreply.github.com>
tedinski
pushed a commit
that referenced
this pull request
Apr 27, 2022
* update unwind documentation Co-authored-by: Adrian Palacios <73246657+adpaco-aws@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
The new unwind flags and annotations options need to be documented for the user. I thought it made most sense to add to the loop tutorial section where users are instructed on how to set unwind values.
Call-outs:
It's possible that this is not the right place to add this documentation, or that the phrasing is not great. Since fixing is easy and cheap, it can just be addressed within the PR.
Testing:
How is this change tested?
Is this a refactor change?
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.