Github user tzulitai commented on a diff in the pull request:
https://github.com/apache/flink/pull/5922#discussion_r186339587
--- Diff: docs/dev/stream/state/broadcast_state.md ---
@@ -25,27 +25,25 @@ under the License.
* ToC
{:toc}
-[Working with State](state.html) described operator state which is either
**evenly** distributed among the parallel
-tasks of an operator, or state which **upon restore**, its partial (task)
states are **unioned** and the whole state is
-used to initialize the restored parallel tasks.
+[Working with State](state.html) describes operator state which upon
restore is either evenly distributed among the
+parallel tasks of an operator, or unioned, with the whole state being used
to initialize the restored parallel tasks.
-A third type of supported *operator state* is the *Broadcast State*.
Broadcast state was introduced to support use-cases
+A third type of supported *operator state* is the *Broadcast State*.
Broadcast state was introduced to support use cases
where some data coming from one stream is required to be broadcasted to
all downstream tasks, where it is stored locally
and is used to process all incoming elements on the other stream. As an
example where broadcast state can emerge as a
natural fit, one can imagine a low-throughput stream containing a set of
rules which we want to evaluate against all
-elements coming from another stream. Having the above type of use-cases in
mind, broadcast state differs from the rest
+elements coming from another stream. Having the above type of use cases in
mind, broadcast state differs from the rest
of operator states in that:
1. it has a map format,
- 2. it is only available to streams whose elements are *broadcasted*,
- 3. the only operation available to a stream with broadcast state is to be
*connected* to another keyed or non-keyed stream,
- 4. such a broadcast stream can have *multiple broadcast states* with
different names.
+ 2. it is only available to specific operators that have as inputs a
*broadcasted* stream and a *non-broadcasted* one, and
--- End diff --
This looks good now (from what I read of it :) )!
---
