Skip to content
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.

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

[FLINK-35395][core] Fix KeyedStateStore class annotation error #24808

Merged
merged 1 commit into from
May 21, 2024

Conversation

usberkeley
Copy link
Contributor

What is the purpose of the change

[FLINK-35395][core] Fix KeyedStateStore class annotation error

Brief change log

There is an error in the annotation of the getState method of the KeyedStateStore class.
The example in the comments is to count the number of occurrences of each ID, but there are some logic errors.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (yes)
  • The serializers: (no)
  • The runtime per-record code paths (performance sensitive): (no)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
  • The S3 file system connector: (no)

Documentation

  • Does this pull request introduce a new feature? (no)

@flinkbot
Copy link
Collaborator

flinkbot commented May 18, 2024

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Copy link
Member

@reswqa reswqa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix.

I wonder what does annotation error's mean? Isn't that just a java doc error?

@usberkeley
Copy link
Contributor Author

Thanks for the fix.

I wonder what does annotation error's mean? Isn't that just a java doc error?

I read the guide (https://flink.apache.org/how-to-contribute/overview/) and I don’t know if it is a doc error, because the guide indicates that the document is stored in the /doc directory of the warehouse, and here are the comments of the code. Is my understanding wrong? Please help me figure out what to do next

@reswqa
Copy link
Member

reswqa commented May 20, 2024

Oh, /doc means flink documentation, while java doc means the doc/comments on java class/interface/method/field.

But It doesn't matter, this fix is good enough. Would you mind changing the commit message to [FLINK-35395][core] Fix the example code of KeyedStateStore#getState?

@usberkeley
Copy link
Contributor Author

Oh, /doc means flink documentation, while java doc means the doc/comments on java class/interface/method/field.

But It doesn't matter, this fix is good enough. Would you mind changing the commit message to [FLINK-35395][core] Fix the example code of KeyedStateStore#getState?

Yes, it's just a java doc error, thank you.

Okay, the commit message has been modified.

@reswqa reswqa merged commit 5f5722f into apache:master May 21, 2024
@reswqa
Copy link
Member

reswqa commented May 21, 2024

Thanks @usberkeley 👍 , merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants