[FLINK-19197] [docs] Add documentation for PersistedStateRegistry #147
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sjwiesman
reviewed
Sep 11, 2020
| ### Dynamic State Registration | ||
|
|
||
| Using the above state types, a function's persisted state must be defined eagerly. You cannot use those state types to | ||
| register new persisted state during invocations (i.e. in the ``invoke`` method) or after the function instance is created. |
There was a problem hiding this comment.
Suggested change
| register new persisted state during invocations (i.e. in the ``invoke`` method) or after the function instance is created. | |
| register a new persisted state during invocations (i.e., in the ``invoke`` method) or after the function instance is created. |
| Using the above state types, a function's persisted state must be defined eagerly. You cannot use those state types to | ||
| register new persisted state during invocations (i.e. in the ``invoke`` method) or after the function instance is created. | ||
|
|
||
| If dynamic state registration is required, you can use a ``PersistedStateRegistry`` to achieve that: |
There was a problem hiding this comment.
I can't exactly explain why, but the way you wrote it sounds off to me.
Suggested change
| If dynamic state registration is required, you can use a ``PersistedStateRegistry`` to achieve that: | |
| If dynamic state registration is required, it can be achieved using a ``PersistedStateRegistry``: |
|
Thanks for the review @sjwiesman! Merging this now (with your suggestions applied). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview of the new documentation: