Skip to content

Fix the java doc for Combine.perKey and ApproximateQuantiles #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
peihe wants to merge 1 commit into from
Closed

Fix the java doc for Combine.perKey and ApproximateQuantiles #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/ApproximateQuantiles.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ private ApproximateQuantiles() {
* {@code numQuantiles-2} intermediate values, and maximum value, in
* sorted order, using the given {@code Comparator} to order values.
* To compute traditional {@code N}-tiles, one should use
* {@code ApproximateQuantiles.globally(compareFn, N+1)}.
* {@code ApproximateQuantiles.globally(N+1, compareFn)}.
*
* <p>If there are fewer input elements than {@code numQuantiles},
* then the result {@code List} will contain all the input elements,
Expand All @@ -86,7 +86,7 @@ private ApproximateQuantiles() {
* <pre> {@code
* PCollection<String> pc = ...;
* PCollection<List<String>> quantiles =
* pc.apply(ApproximateQuantiles.globally(stringCompareFn, 11));
* pc.apply(ApproximateQuantiles.globally(11, stringCompareFn));
* } </pre>
*
* @param <T> the type of the elements in the input {@code PCollection}
Expand Down
2 changes: 1 addition & 1 deletion sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/Combine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1661,7 +1661,7 @@ protected SimpleCombineFn(SerializableFunction<Iterable<V>, V> combiner) {
* <pre> {@code
* PCollection<KV<String, Double>> salesRecords = ...;
* PCollection<KV<String, Double>> totalSalesPerPerson =
* salesRecords.apply(Combine.<String, Double>perKey(
* salesRecords.apply(Combine.<String, Double, Double>perKey(
* new Sum.SumDoubleFn()));
* } </pre>
*
Expand Down