GitHub user F30 opened a pull request:

    https://github.com/apache/storm/pull/1018

    Improve mention of aggregate() in the partitionAggregate() docs

    This simplifies the mention of `CombinerAggregator` benefits in the 
`partitionAggregate()` docs and adds a reference to the specific documentation.
    
    Reading the respective paragraph, it took me some time to figure out that 
`aggregate()` is covered in detail below. I originally thought that it was 
mostly undocumented and began reading the source.
    
    The actual optimizations are described in the `aggregate()` section much 
more exhaustively, so I don't think they need to be covered here. Also, in the 
old wording it was unclear what the benefits should be compared to, because 
other aggregator types are only introduced afterwards.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/F30/storm partitionAggregate-docs

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/storm/pull/1018.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1018
    
----
commit 338262d29debbb8f21075b9507ed1e81d130e5c8
Author: Felix Dreissig <[email protected]>
Date:   2016-01-15T23:48:12Z

    Improve mention of aggregate() in the partitionAggregate() docs
    
    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.

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---

Reply via email to