Improve mention of aggregate() in the partitionAggregate() docs #2362
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
srdo
reviewed
Oct 8, 2017
docs/Trident-API-Overview.md
Outdated
| @@ -484,7 +484,7 @@ public class Count implements CombinerAggregator<Long> { | |||
| } | |||
| ``` | |||
|
|
|||
| The benefits of CombinerAggregators are seen when you use them with the aggregate method instead of partitionAggregate. In that case, Trident automatically optimizes the computation by doing partial aggregations before transferring tuples over the network. | |||
| CombinerAggregators offer high efficiency when used with the aggregate method instead of partitionAggregate (see below). | |||
There was a problem hiding this comment.
I'm a little unsure which part of the document below this is referring to. Can you insert a link instead, e.g. using https://gist.github.com/asabaylus/3071099?
There was a problem hiding this comment.
I have added a link now.
F30
force-pushed
the
partitionAggregate-docs
branch
from
9710434
to
b5efd93
Compare
It was not obvious (to me) that aggregate() is covered in detail at another place in the document. That specific section describes the details of the optimization much more exhaustively. Also, it was unclear what the benefits should be compared to, because other aggregator types are only introduced afterwards.
F30
force-pushed
the
partitionAggregate-docs
branch
from
b5efd93
to
38a32f8
Compare
|
Thanks, +1 |
|
Merged to master, 1.x and 1.1.x. |
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 is a revival of #1018: It took a while, but I have now rebased the changes onto the current master and adjusted the base branch.
However, #1018 is in "missing common history" mode after force-pushing the new commits. Changing the base branch didn't cause the diff to be recomputed, so the Pull Request cannot be re-opened.
Therefore, this new PR is required.