[
https://issues.apache.org/jira/browse/FLINK-10072?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16571171#comment-16571171
]
ASF GitHub Bot commented on FLINK-10072:
----------------------------------------
rickhofstede 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_r208112215
##########
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:
That is not completely right. In the original code, the line break was
forced by the empty white line after (nested) list. However, that causes the
(outer) list enumeration to be broken; the items "_the ReadOnlyContext in the
processElement()_" and "_the Context in the processBroadcastElement()_" both
have a numeration of "_1_" in the original code.
So to solve the enumeration problem, we have to take out the empty white
line. That however implies that we have to include an explicit line break.
----------------------------------------------------------------
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:
[email protected]
> 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
(v7.6.3#76005)
