Minor: improve documentation of AggregateMode
#14946
Merged
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
wiedld
approved these changes
Feb 28, 2025
Co-authored-by: wiedld <wiedld@users.noreply.github.com>
github-actions
bot
removed
the
documentation
2010YOUY01
approved these changes
Mar 1, 2025
Co-authored-by: Yongting You <2010youy01@gmail.com>
|
Thank you for the review @2010YOUY01 and @wiedld |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
Rationale for this change
I have always found
AggregateModeto be somewhat confusing -- I think theSinglevsSinglePartitionedspecifically is confusing as there is both how many aggregation layers as well as how many partitioned@berkaysynnada has pointed out the key difference here https://github.com/apache/datafusion/pull/14919/files#r1975931108 and I wanted to capture that in the documentation
What changes are included in this PR?
Update the documentation on AggregationMode to make the requirements clearer
Are these changes tested?
By CI
Are there any user-facing changes?
Only documentation