flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fhueske <...@git.apache.org>
Subject [GitHub] incubator-flink pull request: [FLINK-1112] Add KeySelector group s...
Date Mon, 01 Dec 2014 15:23:19 GMT
Github user fhueske commented on a diff in the pull request:

    https://github.com/apache/incubator-flink/pull/209#discussion_r21094436
  
    --- Diff: flink-java/src/main/java/org/apache/flink/api/java/operators/UnsortedGrouping.java
---
    @@ -230,5 +231,21 @@ public UnsortedGrouping(DataSet<T> set, Keys<T> keys)
{
     	public SortedGrouping<T> sortGroup(String field, Order order) {
     		return new SortedGrouping<T>(this.dataSet, this.keys, field, order);
     	}
    +
    +	/**
    +	 * Sorts Pojos or Tuple within a group with specified {@link org.apache.flink.api.java.functions.KeySelector}
in the specified {@link Order}.</br>
    --- End diff --
    
    The JavaDoc documentation needs some work, IMO.
    KeySelectors are not restricted to Pojos and Tuples. They can extract a key from any data
type.
    I would phrase it as: "Sorts elements within a group on a key extracted by the specified
KeySelector in the specified order."
    
    The `@param order` refers to a field which has not been mentioned before. Should be the
key extracted by the KeySelector.


---
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