abhijitShandilya opened a new pull request #12735:
URL: https://github.com/apache/flink/pull/12735


   [FLINK-18283] [JavDocs] [API/Core,API/DataStream]
   Update outdated Javadoc for *clear* method of ProcessWindowFunction
   
   ## What is the purpose of the change
   
   - We want to edit the javadocs for ProcessWindowFunction's *clear* method so 
that it reflects the actual behavior.
   - Please see 
[FLINK-18283](https://issues.apache.org/jira/browse/FLINK-18283) for detailed 
description of the issue.
   
   ## Brief change log
     - Change the javadoc for ProcessWindowFunction's *clear* method from
          > Deletes any state in the Context when the Window is purged
   
          to
          > Deletes any state in the Context when the Window expires (the 
watermark passes its maxTimestamp + allowedLateness).
   
   
   ## Verifying this change
   
   This change is a trivial rework / code cleanup without any test coverage.
   - Manually verified in my IDE that the correct javadocs show up for 
[Java](https://user-images.githubusercontent.com/6713854/85186132-1b176c80-b24c-11ea-87d3-185fad39351d.png)
 and 
[Scala](https://user-images.githubusercontent.com/6713854/85186131-181c7c00-b24c-11ea-8861-d6d636722aaf.png).
   - Ran the pipeline on Azure and all the builds passed (including 
e2e_ci_build)
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): **no**
     - The public API, i.e., is any changed class annotated with 
`@Public(Evolving)`: **no**
     - The serializers: **no**
     - The runtime per-record code paths (performance sensitive): **no**
     - Anything that affects deployment or recovery: JobManager (and its 
components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: **no**
     - The S3 file system connector: **no**
   
   ## Documentation
   
     - Does this pull request introduce a new feature? **no**
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to