flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-10072) Syntax and consistency issues in "The Broadcast State Pattern"
Date Tue, 14 Aug 2018 08:42:00 GMT

    [ https://issues.apache.org/jira/browse/FLINK-10072?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16579447#comment-16579447

ASF GitHub Bot commented on FLINK-10072:

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
   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:

> Syntax and consistency issues in "The Broadcast State Pattern"
> --------------------------------------------------------------
>                 Key: FLINK-10072
>                 URL: https://issues.apache.org/jira/browse/FLINK-10072
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation, Streaming
>    Affects Versions: 1.5.2
>            Reporter: Rick Hofstede
>            Priority: Trivial
>              Labels: pull-request-available
> There are several issues in the documentation for "[The Broadcast State Pattern|https://ci.apache.org/projects/flink/flink-docs-stable/dev/stream/state/broadcast_state.html]":
>  # Indentation mixes up whitespace and tabs, causing the markdown layout to be crippled
(especially related to indentation),
>  # Broken (nested) list layout, causing multi-item lists to be rendered as single-item
lists, and
>  # inconsistent list layout.

This message was sent by Atlassian JIRA

View raw message