Skip to content

[hotfix] [docs] Fix typo in state v2 docs #26890

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: release-2.1
Choose a base branch
from
Open

[hotfix] [docs] Fix typo in state v2 docs #26890

wants to merge 2 commits into from
+2 −2

Conversation

ndrake
Copy link

@ndrake ndrake commented Aug 11, 2025

What is the purpose of the change

Fix typo in documentation

Brief change log

Fixed typo on Working with State V2 (New APIs) page

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): no
  • 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
  • If yes, how is the feature documented? not applicable

@flinkbot
Copy link
Collaborator

flinkbot commented Aug 11, 2025 •
edited
Loading

CI report:

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

davidradl
davidradl reviewed Aug 13, 2025
View reviewed changes
docs/content/docs/dev/datastream/fault-tolerance/state_v2.md
@@ -105,7 +105,7 @@ We only focus on the asynchronous ones here.
First of all, we should get familiar with the return value of those asynchronous state access methods.

`StateFuture<T>` is a future that will be completed with the result of the state access.
The return bype is T. It provides multiple methods to handle the result, listed as:
The return type is T. It provides multiple methods to handle the result, listed as:
Copy link
Contributor

Choose a reason for hiding this comment

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

we should also correct the Chinese version

Copy link
Author

Choose a reason for hiding this comment

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

done

@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Aug 13, 2025
@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Aug 20, 2025
Zakelly
Zakelly approved these changes Aug 21, 2025
View reviewed changes
Copy link
Contributor

@Zakelly Zakelly left a comment

Choose a reason for hiding this comment

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

LGTM. Would you please create another PR to branch master

@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Aug 22, 2025
@github-actions github-actions bot added community-reviewed PR has been reviewed by the community. and removed community-reviewed PR has been reviewed by the community. labels Aug 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Zakelly Zakelly Zakelly approved these changes

+1 more reviewer

@davidradl davidradl davidradl left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
community-reviewed PR has been reviewed by the community.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ndrake @flinkbot @Zakelly @davidradl