Skip to content

[hotfix] Fix watermark javadoc #26884

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+4 −4
Open

[hotfix] Fix watermark javadoc #26884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6adf544
docs: fix python docstring
bivouak Aug 8, 2025
ba921f8
docs: fix javadoc
bivouak Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions flink-core/src/main/java/org/apache/flink/api/common/eventtime/WatermarkStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,8 @@ static <T> WatermarkStrategy<T> forMonotonousTimestamps() {
/**
* Creates a watermark strategy for situations where records are out of order, but you can place
* an upper bound on how far the events are out of order. An out-of-order bound B means that
* 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

*
* <p>The watermarks are generated periodically. The delay introduced by this watermark strategy
* is the periodic interval length, plus the out of orderness bound.
Expand Down
4 changes: 2 additions & 2 deletions flink-python/pyflink/common/watermark_strategy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ def for_bounded_out_of_orderness(max_out_of_orderness: Duration) -> 'WatermarkSt
"""
Creates a watermark strategy for situations where records are out of order, but you can
place an upper bound on how far the events are out of order. An out-of-order bound B means
that once the an event with timestamp T was encountered, no events older than (T - B) will
follow any more.
that once an event with timestamp T was encountered, no events older than (T - B) will
follow anymore.
"""
JWaterMarkStrategy = get_gateway().jvm \
.org.apache.flink.api.common.eventtime.WatermarkStrategy
Expand Down