[jira] [Created] (FLINK-21931) Watermark documentation needs to be fixed

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-21931) Watermark documentation needs to be fixed

Shang Yuanchun (Jira)
Matthias created FLINK-21931:
--------------------------------

             Summary: Watermark documentation needs to be fixed
                 Key: FLINK-21931
                 URL: https://issues.apache.org/jira/browse/FLINK-21931
             Project: Flink
          Issue Type: Bug
          Components: Documentation, Runtime / Checkpointing
            Reporter: Matthias


There's a [ML thread|http://apache-flink-user-mailing-list-archive.2336050.n4.nabble.com/pipeline-auto-watermark-interval-vs-setAutoWatermarkInterval-td41891.html] about inconsistencies in the Watermark documentation. The description provided by the docs about setting {{pipeline.auto-watermark-interval}} to {{0}} does not match the actual implementation and the description provided in the JavaDocs of [ExecutionConfig.setAutoWatermarkInterval|https://ci.apache.org/projects/flink/flink-docs-master/api/java/org/apache/flink/api/common/ExecutionConfig.html#setAutoWatermarkInterval-long-].

I went through the code verifying that the functionality described by the JavaDoc is correct. Setting the parameter to {{0}} disables the automatic watermark generation. The docs need to be updated accordingly.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)