You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ku...@apache.org on 2019/03/04 13:54:30 UTC
[flink] branch master updated: [hotfix] Fix typo in some API
comments (#7867)
This is an automated email from the ASF dual-hosted git repository.
kurt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new c6f3dbc [hotfix] Fix typo in some API comments (#7867)
c6f3dbc is described below
commit c6f3dbc3c85a438e6de04109d730f1cd849acf4f
Author: Benchao Li <li...@gmail.com>
AuthorDate: Mon Mar 4 21:54:22 2019 +0800
[hotfix] Fix typo in some API comments (#7867)
* Fix typos in DataStream
* merge other fixes into one PR
---
.../apache/flink/streaming/api/datastream/DataStream.java | 14 +++++++-------
.../flink/streaming/api/datastream/JoinedStreams.java | 2 +-
.../flink/streaming/api/datastream/WindowedStream.java | 2 +-
.../api/transformations/OneInputTransformation.java | 2 +-
.../api/transformations/TwoInputTransformation.java | 4 ++--
5 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/DataStream.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/DataStream.java
index a0af5f1..b33ed2f 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/DataStream.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/DataStream.java
@@ -234,7 +234,7 @@ public class DataStream<T> {
* {@link org.apache.flink.streaming.api.collector.selector.OutputSelector}
* for directing the tuples.
* @return The {@link SplitStream}
- * @deprecated Please use side ouput instead.
+ * @deprecated Please use side output instead.
*/
@Deprecated
public SplitStream<T> split(OutputSelector<T> outputSelector) {
@@ -349,7 +349,7 @@ public class DataStream<T> {
* <p>Note: This method works only on single field keys.
*
* @param partitioner The partitioner to assign partitions to keys.
- * @param field The field index on which the DataStream is to partitioned.
+ * @param field The field index on which the DataStream is partitioned.
* @return The partitioned DataStream.
*/
public <K> DataStream<T> partitionCustom(Partitioner<K> partitioner, int field) {
@@ -364,7 +364,7 @@ public class DataStream<T> {
* <p>Note: This method works only on single field keys.
*
* @param partitioner The partitioner to assign partitions to keys.
- * @param field The expression for the field on which the DataStream is to partitioned.
+ * @param field The expression for the field on which the DataStream is partitioned.
* @return The partitioned DataStream.
*/
public <K> DataStream<T> partitionCustom(Partitioner<K> partitioner, String field) {
@@ -405,7 +405,7 @@ public class DataStream<T> {
/**
* Sets the partitioning of the {@link DataStream} so that the output elements
- * are broadcast to every parallel instance of the next operation.
+ * are broadcasted to every parallel instance of the next operation.
*
* @return The DataStream with broadcast partitioning set.
*/
@@ -797,10 +797,10 @@ public class DataStream<T> {
}
/**
- * Windows this data stream to a {@code KeyedTriggerWindowDataStream}, which evaluates windows
- * over a key grouped stream. Elements are put into windows by a
+ * Windows this data stream to a {@code AllWindowedStream}, which evaluates windows
+ * over a non key grouped stream. Elements are put into windows by a
* {@link org.apache.flink.streaming.api.windowing.assigners.WindowAssigner}. The grouping of
- * elements is done both by key and by window.
+ * elements is done by window.
*
* <p>A {@link org.apache.flink.streaming.api.windowing.triggers.Trigger} can be defined to specify
* when windows are evaluated. However, {@code WindowAssigners} have a default {@code Trigger}
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/JoinedStreams.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/JoinedStreams.java
index 4c327bf..441b97b 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/JoinedStreams.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/JoinedStreams.java
@@ -50,7 +50,7 @@ import static java.util.Objects.requireNonNull;
* <p>Example:
* <pre> {@code
* DataStream<Tuple2<String, Integer>> one = ...;
- * DataStream<Tuple2<String, Integer>> twp = ...;
+ * DataStream<Tuple2<String, Integer>> two = ...;
*
* DataStream<T> result = one.join(two)
* .where(new MyFirstKeySelector())
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/WindowedStream.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/WindowedStream.java
index 24e1d12..e6682e6 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/WindowedStream.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/datastream/WindowedStream.java
@@ -90,7 +90,7 @@ import static org.apache.flink.util.Preconditions.checkNotNull;
* When using an evictor window performance will degrade significantly, since
* incremental aggregation of window results cannot be used.
*
- * <p>Note that the {@code WindowedStream} is purely and API construct, during runtime the
+ * <p>Note that the {@code WindowedStream} is purely an API construct, during runtime the
* {@code WindowedStream} will be collapsed together with the {@code KeyedStream} and the operation
* over the window into one single operation.
*
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/OneInputTransformation.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/OneInputTransformation.java
index b39ce27..26b308d 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/OneInputTransformation.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/OneInputTransformation.java
@@ -83,7 +83,7 @@ public class OneInputTransformation<IN, OUT> extends StreamTransformation<OUT> {
}
/**
- * Returns the {@code TwoInputStreamOperator} of this Transformation.
+ * Returns the {@code OneInputStreamOperator} of this Transformation.
*/
public OneInputStreamOperator<IN, OUT> getOperator() {
return operator;
diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/TwoInputTransformation.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/TwoInputTransformation.java
index 1c75921..ecc1db2 100644
--- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/TwoInputTransformation.java
+++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/transformations/TwoInputTransformation.java
@@ -83,7 +83,7 @@ public class TwoInputTransformation<IN1, IN2, OUT> extends StreamTransformation<
}
/**
- * Returns the first input {@code StreamTransformation} of this {@code TwoInputTransformation}.
+ * Returns the second input {@code StreamTransformation} of this {@code TwoInputTransformation}.
*/
public StreamTransformation<IN2> getInput2() {
return input2;
@@ -97,7 +97,7 @@ public class TwoInputTransformation<IN1, IN2, OUT> extends StreamTransformation<
}
/**
- * Returns the {@code TypeInformation} for the elements from the first input.
+ * Returns the {@code TypeInformation} for the elements from the second input.
*/
public TypeInformation<IN2> getInputType2() {
return input2.getOutputType();