beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From swegner <...@git.apache.org>
Subject [GitHub] incubator-beam pull request #675: Clean up Aggregator javadoc
Date Mon, 18 Jul 2016 17:05:14 GMT
GitHub user swegner opened a pull request:

    https://github.com/apache/incubator-beam/pull/675

    Clean up Aggregator javadoc

    Be sure to do all of the following to help us incorporate your contribution
    quickly and easily:
    
     - [ ] Make sure the PR title is formatted like:
       `[BEAM-<Jira issue #>] Description of pull request`
     - [ ] Make sure tests pass via `mvn clean verify`. (Even better, enable
           Travis-CI on your fork and ensure the whole test matrix passes).
     - [ ] Replace `<Jira issue #>` in the title with the actual Jira issue
           number, if there is one.
     - [ ] If this contribution is large, please file an Apache
           [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.txt).
    
    ---
    The [current javadoc for `Aggregator`](http://beam.incubator.apache.org/javadoc/0.1.0-incubating/org/apache/beam/sdk/transforms/Aggregator.html)
is difficult to read:
    
    > Aggregators are created by calling `DoFn.createAggregator(java.lang.String, org.apache.beam.sdk.transforms.Combine.CombineFn<?
super AggInputT, ?, AggOutputT>)`, typically from the `DoFn` constructor. Elements can
be added to the Aggregator by calling `addValue(InputT)`.
    
    This simply takes the function parameters out of `createAggregator`:
    
    > Aggregators are created by calling `DoFn.createAggregator()`, typically from the
`DoFn` constructor. Elements can be added to the Aggregator by calling `addValue(InputT)`.


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

    $ git pull https://github.com/swegner/incubator-beam aggregator-javadoc

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

    https://github.com/apache/incubator-beam/pull/675.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 #675
    
----
commit bfd43ca0ddc99aa81c0f4cb3ad7e757da63fa217
Author: Scott Wegner <swegner@google.com>
Date:   2016-07-18T17:01:29Z

    Clean up Aggregator javadoc

----


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message