[FLINK-7038] Several misused "KeyedDataStream" term in docs and Javadocs - ASF JIRA

Details

Type: Bug
Status: Resolved
Priority: Trivial
Resolution: Fixed
Affects Version/s: 1.3.1, 1.4.0
Fix Version/s: 1.4.0, 1.3.2
Component/s: Documentation
Labels:
- starter

Description

The correct term should be KeyedStream.

For example, in https://ci.apache.org/projects/flink/flink-docs-release-1.3/dev/datastream_api.html, it says "See keys on how to specify keys. This transformation returns a KeyedDataStream."

Issue Links

links to

GitHub Pull Request #4229

Activity

Descending order - Click to sort in ascending order

Hide

Permalink

Tzu-Li (Gordon) Tai added a comment - 06/Jul/17 04:30

Fixed for master via d6c714804c029f2256789d2d09a401533c5aca91
Fixed for 1.3 via 0c9a0b96212d7d1549e4d66b23ddbfd982b19b1d

Show

Tzu-Li (Gordon) Tai added a comment - 06/Jul/17 04:30 Fixed for master via d6c714804c029f2256789d2d09a401533c5aca91 Fixed for 1.3 via 0c9a0b96212d7d1549e4d66b23ddbfd982b19b1d

Hide

Permalink

ASF GitHub Bot added a comment - 06/Jul/17 04:24

Github user asfgit closed the pull request at:

https://github.com/apache/flink/pull/4229

Show

ASF GitHub Bot added a comment - 06/Jul/17 04:24 Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/4229

Hide

Permalink

ASF GitHub Bot added a comment - 04/Jul/17 07:36

Github user tzulitai commented on the issue:

https://github.com/apache/flink/pull/4229

LGTM, merging ..

Show

ASF GitHub Bot added a comment - 04/Jul/17 07:36 Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4229 LGTM, merging ..

Hide

Permalink

ASF GitHub Bot added a comment - 01/Jul/17 08:53

Github user zhangminglei commented on a diff in the pull request:

https://github.com/apache/flink/pull/4229#discussion_r125158619

— Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AppendingState.java —
@@ -29,7 +29,7 @@

The state is accessed and modified by user functions, and checkpointed consistently
by the system as part of the distributed snapshots.

* The state is only accessible by functions applied on a KeyedDataStream. The key is
+ * The state is only accessible by functions applied on a KeyedStream. The key is
- - End diff –

I probably not set this to ```@link``` , instead, I would set this to ```@code```, because if I use ```link```, it can not be recognized by compiler. I have to add the pom.xml to the module. And I think it is not suitable. What do you think ?

Show

ASF GitHub Bot added a comment - 01/Jul/17 08:53 Github user zhangminglei commented on a diff in the pull request: https://github.com/apache/flink/pull/4229#discussion_r125158619 — Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AppendingState.java — @@ -29,7 +29,7 @@ The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * The state is only accessible by functions applied on a KeyedDataStream. The key is + * The state is only accessible by functions applied on a KeyedStream. The key is End diff – I probably not set this to ```@link``` , instead, I would set this to ```@code```, because if I use ```link```, it can not be recognized by compiler. I have to add the pom.xml to the module. And I think it is not suitable. What do you think ?

Hide

Permalink

ASF GitHub Bot added a comment - 01/Jul/17 08:44

Github user zhangminglei commented on a diff in the pull request:

https://github.com/apache/flink/pull/4229#discussion_r125158516

— Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AggregatingState.java —
@@ -33,7 +33,7 @@

The state is accessed and modified by user functions, and checkpointed consistently
by the system as part of the distributed snapshots.

* The state is only accessible by functions applied on a KeyedDataStream. The key is
+ * The state is only accessible by functions applied on a KeyedStream. The key is
- - End diff –

I remember next time as I did not know before like this style. thanks.

Show

ASF GitHub Bot added a comment - 01/Jul/17 08:44 Github user zhangminglei commented on a diff in the pull request: https://github.com/apache/flink/pull/4229#discussion_r125158516 — Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AggregatingState.java — @@ -33,7 +33,7 @@ The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * The state is only accessible by functions applied on a KeyedDataStream. The key is + * The state is only accessible by functions applied on a KeyedStream. The key is End diff – I remember next time as I did not know before like this style. thanks.

Hide

Permalink

ASF GitHub Bot added a comment - 01/Jul/17 07:55

Github user zhangminglei commented on the issue:

https://github.com/apache/flink/pull/4229

Yep. I will update code again soon enough.

Show

ASF GitHub Bot added a comment - 01/Jul/17 07:55 Github user zhangminglei commented on the issue: https://github.com/apache/flink/pull/4229 Yep. I will update code again soon enough.

Hide

Permalink

ASF GitHub Bot added a comment - 01/Jul/17 06:22

Github user tzulitai commented on a diff in the pull request:

https://github.com/apache/flink/pull/4229#discussion_r125155752

— Diff: flink-core/src/main/java/org/apache/flink/api/common/state/FoldingState.java —
@@ -28,7 +28,7 @@

The state is accessed and modified by user functions, and checkpointed consistently
by the system as part of the distributed snapshots.

* The state is only accessible by functions applied on a KeyedDataStream. The key is
+ * The state is only accessible by functions applied on a KeyedStream. The key is
- - End diff –

Could you also change these to be actual Javadoc links?
i.e. `

{@link KeyedStream}

Show

ASF GitHub Bot added a comment - 01/Jul/17 06:22 Github user tzulitai commented on a diff in the pull request: https://github.com/apache/flink/pull/4229#discussion_r125155752 — Diff: flink-core/src/main/java/org/apache/flink/api/common/state/FoldingState.java — @@ -28,7 +28,7 @@ The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * The state is only accessible by functions applied on a KeyedDataStream. The key is + * The state is only accessible by functions applied on a KeyedStream. The key is End diff – Could you also change these to be actual Javadoc links? i.e. ` {@link KeyedStream} `.

Hide

Permalink

ASF GitHub Bot added a comment - 01/Jul/17 06:22

Github user tzulitai commented on a diff in the pull request:

https://github.com/apache/flink/pull/4229#discussion_r125155750

— Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AppendingState.java —
@@ -29,7 +29,7 @@

The state is accessed and modified by user functions, and checkpointed consistently
by the system as part of the distributed snapshots.

* The state is only accessible by functions applied on a KeyedDataStream. The key is
+ * The state is only accessible by functions applied on a KeyedStream. The key is
- - End diff –

Could you also change these to be actual Javadoc links?
i.e. `

{@link KeyedStream}

Show

ASF GitHub Bot added a comment - 01/Jul/17 06:22 Github user tzulitai commented on a diff in the pull request: https://github.com/apache/flink/pull/4229#discussion_r125155750 — Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AppendingState.java — @@ -29,7 +29,7 @@ The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * The state is only accessible by functions applied on a KeyedDataStream. The key is + * The state is only accessible by functions applied on a KeyedStream. The key is End diff – Could you also change these to be actual Javadoc links? i.e. ` {@link KeyedStream} `.

Hide

Permalink

ASF GitHub Bot added a comment - 01/Jul/17 06:22

Github user tzulitai commented on a diff in the pull request:

https://github.com/apache/flink/pull/4229#discussion_r125155753

— Diff: flink-core/src/main/java/org/apache/flink/api/common/state/State.java —
@@ -23,7 +23,7 @@
/**

Interface that different types of partitioned state must implement.
*

* The state is only accessible by functions applied on a KeyedDataStream. The key is
+ * The state is only accessible by functions applied on a KeyedStream. The key is
- - End diff –

Could you also change these to be actual Javadoc links?
i.e. `

{@link KeyedStream}

Show

ASF GitHub Bot added a comment - 01/Jul/17 06:22 Github user tzulitai commented on a diff in the pull request: https://github.com/apache/flink/pull/4229#discussion_r125155753 — Diff: flink-core/src/main/java/org/apache/flink/api/common/state/State.java — @@ -23,7 +23,7 @@ /** Interface that different types of partitioned state must implement. * * The state is only accessible by functions applied on a KeyedDataStream. The key is + * The state is only accessible by functions applied on a KeyedStream. The key is End diff – Could you also change these to be actual Javadoc links? i.e. ` {@link KeyedStream} `.

Hide

Permalink

ASF GitHub Bot added a comment - 01/Jul/17 06:22

Github user tzulitai commented on a diff in the pull request:

https://github.com/apache/flink/pull/4229#discussion_r125155746

— Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AggregatingState.java —
@@ -33,7 +33,7 @@

The state is accessed and modified by user functions, and checkpointed consistently
by the system as part of the distributed snapshots.

* The state is only accessible by functions applied on a KeyedDataStream. The key is
+ * The state is only accessible by functions applied on a KeyedStream. The key is
- - End diff –

Could you also change these to be actual Javadoc links?
i.e. `

{@link KeyedStream}

Show

ASF GitHub Bot added a comment - 01/Jul/17 06:22 Github user tzulitai commented on a diff in the pull request: https://github.com/apache/flink/pull/4229#discussion_r125155746 — Diff: flink-core/src/main/java/org/apache/flink/api/common/state/AggregatingState.java — @@ -33,7 +33,7 @@ The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * The state is only accessible by functions applied on a KeyedDataStream. The key is + * The state is only accessible by functions applied on a KeyedStream. The key is End diff – Could you also change these to be actual Javadoc links? i.e. ` {@link KeyedStream} `.

Hide

Permalink

ASF GitHub Bot added a comment - 30/Jun/17 10:52

Github user zhangminglei commented on the issue:

https://github.com/apache/flink/pull/4229

Hi, @tzulitai I have updated the code. Please check whether it should add more ?

Show

ASF GitHub Bot added a comment - 30/Jun/17 10:52 Github user zhangminglei commented on the issue: https://github.com/apache/flink/pull/4229 Hi, @tzulitai I have updated the code. Please check whether it should add more ?

Hide

Permalink

ASF GitHub Bot added a comment - 30/Jun/17 05:51

Github user zhangminglei commented on the issue:

https://github.com/apache/flink/pull/4229

Exactly, Could we create another jira or just do a hotfix for ```WindowedDataStream``` under ```~~FLINK-7038~~``` ?

Show

ASF GitHub Bot added a comment - 30/Jun/17 05:51 Github user zhangminglei commented on the issue: https://github.com/apache/flink/pull/4229 Exactly, Could we create another jira or just do a hotfix for ```WindowedDataStream``` under ``` FLINK-7038 ``` ?

Hide

Permalink

ASF GitHub Bot added a comment - 30/Jun/17 05:48

Github user tzulitai commented on the issue:

https://github.com/apache/flink/pull/4229

Yes. That's why the `KeyedDataStream` is a misused term. The actual class is called `KeyedStream`.

Show

ASF GitHub Bot added a comment - 30/Jun/17 05:48 Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4229 Yes. That's why the `KeyedDataStream` is a misused term. The actual class is called `KeyedStream`.

Hide

Permalink

ASF GitHub Bot added a comment - 30/Jun/17 05:47

Github user zhangminglei commented on the issue:

https://github.com/apache/flink/pull/4229

Okay. I really found many ```KeyedDataStream``` terms existing in flink project under master branch. But there is not a class called it. So, it is very strange. Also the same stuff refers to ```WindowedDataStream``` in flink. Could you check it again and makes sure I am correct or incorrect.

Show

ASF GitHub Bot added a comment - 30/Jun/17 05:47 Github user zhangminglei commented on the issue: https://github.com/apache/flink/pull/4229 Okay. I really found many ```KeyedDataStream``` terms existing in flink project under master branch. But there is not a class called it. So, it is very strange. Also the same stuff refers to ```WindowedDataStream``` in flink. Could you check it again and makes sure I am correct or incorrect.

Hide

Permalink

ASF GitHub Bot added a comment - 30/Jun/17 04:42

Github user tzulitai commented on the issue:

https://github.com/apache/flink/pull/4229

@zhangminglei thanks for picking this up.

The last time I checked, there's much more misused "KeyedDataStream" terms, both in Javadocs and the documentation. Could you please include fixes for all of those with this PR?

Show

ASF GitHub Bot added a comment - 30/Jun/17 04:42 Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4229 @zhangminglei thanks for picking this up. The last time I checked, there's much more misused "KeyedDataStream" terms, both in Javadocs and the documentation. Could you please include fixes for all of those with this PR?

Hide

Permalink

ASF GitHub Bot added a comment - 30/Jun/17 00:59

GitHub user zhangminglei opened a pull request:

https://github.com/apache/flink/pull/4229

~~FLINK-7038~~ [docs] Correct misused term to KeyedStream

Correct misused term to KeyedStream.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/zhangminglei/flink flink-7038

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/flink/pull/4229.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #4229

commit c77852d306fb0c3b353b69b6be4b50753189f8bf
Author: zhangminglei <zml13856086071@163.com>
Date: 2017-06-30T00:58:12Z

~~FLINK-7038~~ [docs] Correct misused term to KeyedStream

Show

ASF GitHub Bot added a comment - 30/Jun/17 00:59 GitHub user zhangminglei opened a pull request: https://github.com/apache/flink/pull/4229 FLINK-7038 [docs] Correct misused term to KeyedStream Correct misused term to KeyedStream. You can merge this pull request into a Git repository by running: $ git pull https://github.com/zhangminglei/flink flink-7038 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/4229.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #4229 commit c77852d306fb0c3b353b69b6be4b50753189f8bf Author: zhangminglei <zml13856086071@163.com> Date: 2017-06-30T00:58:12Z FLINK-7038 [docs] Correct misused term to KeyedStream

Hide

Permalink

mingleizhang added a comment - 30/Jun/17 00:18

Hello, Gordon. I will look into this today.

Show

mingleizhang added a comment - 30/Jun/17 00:18 Hello, Gordon. I will look into this today.

People

Assignee:

mingleizhang

Reporter:

Tzu-Li (Gordon) Tai

Votes:

0 Vote for this issue

Watchers:

3 Start watching this issue

Dates

Created:

29/Jun/17 10:26

Updated:

06/Jul/17 04:30

Resolved:

06/Jul/17 04:30

Development

Agile

View on Board