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: [Java API] [docs] Rephrase Javadoc o...
Date Mon, 01 Dec 2014 14:28:14 GMT
Github user fhueske commented on a diff in the pull request:

    https://github.com/apache/incubator-flink/pull/244#discussion_r21090988
  
    --- Diff: flink-java/src/main/java/org/apache/flink/api/java/DataSet.java ---
    @@ -285,25 +285,37 @@ public ExecutionEnvironment getExecutionEnvironment() {
     	}
     
     	/**
    -	 * Syntactic sugar for aggregate (MAX, field)
    +	 * Syntactic sugar for {@link #aggregate(Aggregations, int)} using {@link Aggregations#MAX}
as
    +	 * the aggregation function.
    +	 * <p>
    +	 * <strong>Note:</strong> This operation is not to be confused with {@link
#maxBy(int...)},
    +	 * which selects one element with maximum value at the specified field positions.
    +	 *
     	 * @param field The index of the Tuple field on which the aggregation function is applied.
     	 * @return An AggregateOperator that represents the max'ed DataSet.
     	 *
    -	 * @see org.apache.flink.api.java.operators.AggregateOperator
    +	 * @see #aggregate(Aggregations, int)
    +	 * @see #maxBy(int...)
     	 */
    -	public AggregateOperator<T> max (int field) {
    -		return this.aggregate (Aggregations.MAX, field);
    +	public AggregateOperator<T> max(int field) {
    +		return aggregate(Aggregations.MAX, field);
     	}
     
     	/**
    -	 * Syntactic sugar for aggregate (MIN, field)
    +	 * Syntactic sugar for {@link #aggregate(Aggregations, int)} using {@link Aggregations#MIN}
as
    +	 * the aggregation function.
    +	 * <p>
    +	 * <strong>Note:</strong> This operation is not to be confused with {@link
#minBy(int...)},
    +	 * which selects one element with the minimum value at the specified field positions.
    --- End diff --
    
    as above?


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