GitHub user ggevay opened a pull request:
https://github.com/apache/flink/pull/1224
[FLINK-2818] [runtime] Corrected javadocs of *ReduceDriver classes
- "The iterator is handed to the <code>reduce()</code> method of the
ReduceFunction."
In the cases of ReduceDriver and AllReduceDriver, it is not the
iterator which is handed to reduce(), but the elements pairwise
- "The iterator returns all records grouped by their key"
I guess this is not the case with AllReduceDriver and
AllGroupReduceDriver. But someone who knows the code please confirm this!
- AllGroupReduceDriver refers to "RichGroupFunction"
There is no such thing. I guess this should be RichGroupReduceFunction.
- GroupCombineChainedDriver refers to "GroupCombineDriver"
There is no such thing. I guess this should be
GroupReduceCombineDriver? (please confirm)
- *Driver instead of *Task
- In the combineGroup methods in DataSet, SortedGrouping, and
UnsortedGrouping, the text of the NullPointerException is wrong.
- The @return annotation of the first() method refers to
"ReduceGroupOperator" instead of "GroupReduceOperator".
- The javadoc of combineGroup() refers to CombineFunction instead of
GroupCombineFunction
- minor typos
- CombineFunction is not used anywhere (except in comments), but I didn't
do anything about this, because I'm not sure whether it should be removed, or
perhaps there are plans for using it in the future.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ggevay/flink reduce-javadocs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/1224.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 #1224
----
commit 407cd1895f54391fa98f60ce9e39de0c331b4305
Author: Gabor Gevay <[email protected]>
Date: 2015-10-04T18:29:40Z
[FLINK-2818] [runtime] Corrected javadocs of *ReduceDriver classes and some
methods in the API.
----
---
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.
---
