[hotfix] Fix watermark javadoc #26884
Open
+4
−4
Conversation
This file contains hidden or 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
|
@bivouak Please could you follow https://flink.apache.org/how-to-contribute/contribute-code/ and start the tile of the PR with either [Jira number] or [hotfix]. In this case it looks like a hotfix. Note it not a docs change it is a comments change. |
davidradl
reviewed
Aug 15, 2025
| * once the an event with timestamp T was encountered, no events older than {@code T - B} will | ||
| * follow any more. | ||
| * once an event with timestamp T was encountered, no events older than {@code T - B} will | ||
| * follow anymore. |
There was a problem hiding this comment.
This text seems to be almost an incorrect copy of the class javadoc .
I think a link to the class javadoc, with the existing @see or similar and then javadoc including the @param would seem more appropriate. Maybe something like
Creates a watermark strategy for @see BoundedOutOfOrdernessWatermarks using the supplied out-of-order bound
@param maxOutOfOrderness out-of-order bound duration.
github-actions
bot
added
community-reviewed
github-actions
bot
added
community-reviewed
github-actions
bot
added
community-reviewed
github-actions
bot
added
community-reviewed
bivouak
changed the title
bivouak
changed the title
github-actions
bot
added
community-reviewed
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.
What is the purpose of the change
Simple typo fix in the docstring/javadoc.