hg: lambda/lambda/jdk: doc improvements and cleanups

Paul Benedict pbenedict at apache.org
Mon Nov 26 12:32:01 PST 2012


Mike, one suggestion I have is from the Javadocs how-to page:
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

"Use 3rd person (descriptive) not 2nd person (prescriptive).
The description is in 3rd person declarative rather than 2nd person
imperative.
Gets the label. (preferred)
Get the label. (avoid)"

So rather saying this for Function#compose()...
"Combine with another function returning a function which preforms both
functions."
...say...
"Combines with another function returning a function which preforms both
functions."

I think you are using the 2nd person everywhere at the moment.

Paul

On Mon, Nov 26, 2012 at 2:24 PM, <mike.duigou at oracle.com> wrote:

> Changeset: 95fbc3044c96
> Author:    mduigou
> Date:      2012-11-26 12:04 -0800
> URL:       http://hg.openjdk.java.net/lambda/lambda/jdk/rev/95fbc3044c96
>
> doc improvements and cleanups
>
> ! src/share/classes/java/util/function/BiBlock.java
> ! src/share/classes/java/util/function/BiFunction.java
> ! src/share/classes/java/util/function/BinaryOperator.java
> ! src/share/classes/java/util/function/DoubleBinaryOperator.java
> ! src/share/classes/java/util/function/DoubleBlock.java
> ! src/share/classes/java/util/function/DoubleFunction.java
> ! src/share/classes/java/util/function/DoubleUnaryOperator.java
> ! src/share/classes/java/util/function/Function.java
> ! src/share/classes/java/util/function/IntBinaryOperator.java
> ! src/share/classes/java/util/function/IntBlock.java
> ! src/share/classes/java/util/function/IntFunction.java
> ! src/share/classes/java/util/function/IntUnaryOperator.java
> ! src/share/classes/java/util/function/LongBinaryOperator.java
> ! src/share/classes/java/util/function/LongBlock.java
> ! src/share/classes/java/util/function/LongFunction.java
> ! src/share/classes/java/util/function/LongUnaryOperator.java
> ! src/share/classes/java/util/function/Predicate.java
> ! src/share/classes/java/util/function/Predicates.java
>
>
>


More information about the lambda-dev mailing list