Clarify documentation and add doctests #58
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
I found the semantics of `push`/`push_increase`/`push_decrease` somewhat unclear, so I reworded the docs and added doctest examples.
|
Sorry for the late response, I missed this. Thank you for your contribution. I find your wording much clearer and the doctest examples help to understand the semantic |
|
A similar change would be helpful for the |
|
Sure, I'll work on that. |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
I found the semantics of
push/push_increase/push_decreasesomewhat unclear, so I reworded the docs and added doctest examples.