tzulitai commented on a change in pull request #8106: [FLINK-12092]
[docs]Clarity when `onTimer(...)` is called
URL: https://github.com/apache/flink/pull/8106#discussion_r273354765
##########
File path: docs/dev/stream/operators/process_function.md
##########
@@ -44,8 +44,8 @@ For fault-tolerant state, the `ProcessFunction` gives access
to Flink's [keyed s
The timers allow applications to react to changes in processing time and in
[event time]({{ site.baseurl }}/dev/event_time.html).
Every call to the function `processElement(...)` gets a `Context` object which
gives access to the element's
event time timestamp, and to the *TimerService*. The `TimerService` can be
used to register callbacks for future
-event-/processing-time instants. When a timer's particular time is reached,
the `onTimer(...)` method is
-called. During that call, all states are again scoped to the key with which
the timer was created, allowing
+event-/processing-time instants. The `onTimer(...)` method is
+called when such an event-time is first caught up by a watermark or such a
processing-time is reached. During that call, all states are again scoped to
the key with which the timer was created, allowing
Review comment:
I agree we should explain what "when time is reached" means for both event
and processing time, but I'm not sure of the actual changes in the PR.
Maybe something along the lines of:
```
When a timer's particular time is reached, the `onTimer(...)` method is
called; for processing time, this would mean __________, while for event time,
this would mean ______________.
```
----------------------------------------------------------------
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]
With regards,
Apache Git Services
