chore: add docstrings for the undocumented tactics #281
Conversation
This file contains hidden or 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
This PR adds brief documentation for the undocumented tactics: `saturate`, `forward` and `aesop_unfold` (and their variants). These docstrings are written based on reading the code and looking at examples from the test suite, so I might be missing the larger context of how to use them in practice.
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.
This PR adds brief documentation for the undocumented tactics:
saturate,forwardandaesop_unfold(and their variants).These docstrings are written based on reading the code and looking at examples from the test suite, so please check that I correctly capture the larger context of how to use them in practice.