zentol commented on a change in pull request #6503: [FLINK-10072] [docs] Syntax
and consistency issues in "The Broadcast State Pattern"
URL: https://github.com/apache/flink/pull/6503#discussion_r209870859
##########
File path: docs/dev/stream/state/broadcast_state.md
##########
@@ -171,9 +171,8 @@ exposes some functionality which is not available to the
`BroadcastProcessFuncti
to register event and/or processing time timers. When a timer fires, the
`onTimer()` (shown above) is invoked with an
`OnTimerContext` which exposes the same functionality as the
`ReadOnlyContext` plus
- the ability to ask if the timer that fired was an event or processing
time one and
- - to query the key associated with the timer.
-
- This is aligned with the `onTimer()` method of the `KeyedProcessFunction`.
+ - to query the key associated with the timer.<br/>
Review comment:
This part still doesn't look correct.
It's now hard to tell whether `This is aligned with the onTimer() method of
the KeyedProcessFunction.` applies to `the ReadOnlyContext in the
processElement() method ...` or either/both of the sub-items.
We should just re-phrase this part. Actually I would just remove it; as
someone not deeply familiar with process functions I simply assumed that
`KeyedBroadcastProcessFunction#onTimer` works exactly like
`KeyedProcessFunction#onTimer`.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
