[FLINK-21931] Watermark documentation needs to be fixed

• Type: Bug
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 1.12.2
• Component/s: Documentation, Table SQL / API
• Assignee: Unassigned
• Reporter: Matthias Pohl
• Created: 23/Mar/21 14:19
• Updated: 26/Mar/21 06:55

Description

There's a ML thread 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.

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.