Minor: improve GroupsAccumulator and Accumulator documentation #8963
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
github-actions
bot
added
logical-expr
github-actions
bot
removed
the
documentation
Co-authored-by: Jeffrey Vo <[email protected]>
|
Thanks again for the review @Jefffrey |
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.
Which issue does this PR close?
Part of #7013
Rationale for this change
We recently made
GroupsAccumulatorpart of the public API in #8892 (thank you @guojidan ❤️ ). Now that it is public it would be nice to have some additional user facing documentation / rationaleWhat changes are included in this PR?
Update docstrings with explanation of the difference between
AccumulatorandGroupsAccumulatorAre these changes tested?
Existing tests
Are there any user-facing changes?
Doc only