Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-7038

Several misused "KeyedDataStream" term in docs and Javadocs

    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:

      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

          Activity

          Hide
          mingleizhang mingleizhang added a comment -

          Hello, Gordon. I will look into this today.

          Show
          mingleizhang mingleizhang added a comment - Hello, Gordon. I will look into this today.
          Hide
          githubbot ASF GitHub Bot added a comment -

          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
          githubbot ASF GitHub Bot added a comment - 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
          githubbot ASF GitHub Bot added a comment -

          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
          githubbot ASF GitHub Bot added a comment - 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
          githubbot ASF GitHub Bot added a comment -

          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
          githubbot ASF GitHub Bot added a comment - 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
          githubbot ASF GitHub Bot added a comment -

          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
          githubbot ASF GitHub Bot added a comment - 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
          githubbot ASF GitHub Bot added a comment -

          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
          githubbot ASF GitHub Bot added a comment - 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
          githubbot ASF GitHub Bot added a comment -

          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
          githubbot ASF GitHub Bot added a comment - 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
          githubbot ASF GitHub Bot added a comment -

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

          • <p>The state is accessed and modified by user functions, and checkpointed consistently
          • by the system as part of the distributed snapshots.
          • * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is
            + * <p>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
          githubbot ASF GitHub Bot added a comment - 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 @@ <p>The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is + * <p>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
          githubbot ASF GitHub Bot added a comment -

          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.
            *
          • * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is
            + * <p>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
          githubbot ASF GitHub Bot added a comment - 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. * * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is + * <p>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
          githubbot ASF GitHub Bot added a comment -

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

          • <p>The state is accessed and modified by user functions, and checkpointed consistently
          • by the system as part of the distributed snapshots.
          • * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is
            + * <p>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
          githubbot ASF GitHub Bot added a comment - 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 @@ <p>The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is + * <p>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
          githubbot ASF GitHub Bot added a comment -

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

          • <p>The state is accessed and modified by user functions, and checkpointed consistently
          • by the system as part of the distributed snapshots.
          • * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is
            + * <p>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
          githubbot ASF GitHub Bot added a comment - 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 @@ <p>The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is + * <p>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
          githubbot ASF GitHub Bot added a comment -

          Github user zhangminglei commented on the issue:

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

          Yep. I will update code again soon enough.

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

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

          • <p>The state is accessed and modified by user functions, and checkpointed consistently
          • by the system as part of the distributed snapshots.
          • * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is
            + * <p>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
          githubbot ASF GitHub Bot added a comment - 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 @@ <p>The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is + * <p>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
          githubbot ASF GitHub Bot added a comment -

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

          • <p>The state is accessed and modified by user functions, and checkpointed consistently
          • by the system as part of the distributed snapshots.
          • * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is
            + * <p>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
          githubbot ASF GitHub Bot added a comment - 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 @@ <p>The state is accessed and modified by user functions, and checkpointed consistently by the system as part of the distributed snapshots. * <p>The state is only accessible by functions applied on a KeyedDataStream. The key is + * <p>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
          githubbot ASF GitHub Bot added a comment -

          Github user tzulitai commented on the issue:

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

          LGTM, merging ..

          Show
          githubbot ASF GitHub Bot added a comment - Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4229 LGTM, merging ..
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/4229
          Hide
          tzulitai Tzu-Li (Gordon) Tai added a comment -

          Fixed for master via d6c714804c029f2256789d2d09a401533c5aca91
          Fixed for 1.3 via 0c9a0b96212d7d1549e4d66b23ddbfd982b19b1d

          Show
          tzulitai Tzu-Li (Gordon) Tai added a comment - Fixed for master via d6c714804c029f2256789d2d09a401533c5aca91 Fixed for 1.3 via 0c9a0b96212d7d1549e4d66b23ddbfd982b19b1d

            People

            • Assignee:
              mingleizhang mingleizhang
              Reporter:
              tzulitai Tzu-Li (Gordon) Tai
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development