[FLINK-7038] [docs] Correct misused term to KeyedStream #4229
Conversation
|
@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? |
|
Okay. I really found many |
|
Yes. That's why the |
|
Exactly, Could we create another jira or just do a hotfix for |
|
Hi, @tzulitai I have updated the code. Please check whether it should add more ? |
| @@ -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 | |||
There was a problem hiding this comment.
Could you also change these to be actual Javadoc links?
i.e. {@link KeyedStream}.
There was a problem hiding this comment.
I remember next time as I did not know before like this style. thanks. :)
| @@ -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 | |||
There was a problem hiding this comment.
Could you also change these to be actual Javadoc links?
i.e. {@link KeyedStream}.
There was a problem hiding this comment.
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 ?
| @@ -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 | |||
There was a problem hiding this comment.
Could you also change these to be actual Javadoc links?
i.e. {@link KeyedStream}.
| @@ -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 | |||
There was a problem hiding this comment.
Could you also change these to be actual Javadoc links?
i.e. {@link KeyedStream}.
|
Yep. I will update code again soon enough. |
|
LGTM, merging .. |
Correct misused term to KeyedStream.