Skip to content

Commit ec126e6

Browse files
authored
minor: More comments to AggregateMode::PartialReduce (#22800)
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - Closes #. ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> Figured this out when working through the codebase, I think it worth some more comment. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
1 parent 0f8a121 commit ec126e6

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

  • datafusion/physical-plan/src/aggregates

datafusion/physical-plan/src/aggregates/mod.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,12 @@ pub enum AggregateMode {
211211
/// / \ / \
212212
/// Partial Partial Partial Partial
213213
/// ```
214+
///
215+
/// # Motivation
216+
///
217+
/// This reduces shuffling traffic in a distributed setting. See
218+
/// <https://github.com/datafusion-contrib/datafusion-distributed/issues/360>
219+
/// for details.
214220
PartialReduce,
215221
}
216222

0 commit comments

Comments
 (0)