From c066ce4a8aa0593e28511dbcbdcee2845068c4b4 Mon Sep 17 00:00:00 2001 From: Alexander Golubev Date: Fri, 18 Sep 2015 10:02:09 -0400 Subject: [PATCH] =str #18378 Small typos in Streams docs --- akka-docs-dev/rst/java/stream-quickstart.rst | 10 +++++----- akka-docs-dev/rst/scala/stream-quickstart.rst | 2 +- akka-docs-dev/rst/stages-overview.rst | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/akka-docs-dev/rst/java/stream-quickstart.rst b/akka-docs-dev/rst/java/stream-quickstart.rst index 4ecad5d158..fb13ea0fc0 100644 --- a/akka-docs-dev/rst/java/stream-quickstart.rst +++ b/akka-docs-dev/rst/java/stream-quickstart.rst @@ -25,7 +25,7 @@ Here's the data model we'll be working with throughout the quickstart examples: Transforming and consuming simple streams ----------------------------------------- -The example application we will be looking at is a simple Twitter fed stream from which we'll want to extract certain information, +The example application we will be looking at is a simple Twitter feed stream from which we'll want to extract certain information, like for example finding all twitter handles of users who tweet about ``#akka``. In order to prepare our environment by creating an :class:`ActorSystem` and :class:`ActorMaterializer`, @@ -118,10 +118,10 @@ detail in :ref:`constructing-sources-sinks-flows-from-partial-graphs-java`. Flow .. includecode:: ../../../akka-samples/akka-docs-java-lambda/src/test/java/docs/stream/TwitterStreamQuickstartDocTest.java#flow-graph-broadcast -As you can see, we use graph builder to mutably construct the graph using the ``addEdge`` method. Once we have the -FlowGraph in the value ``g`` *it is immutable, thread-safe, and freely shareable*. A graph can be ``run()`` directly - -assuming all ports (sinks/sources) within a flow have been connected properly. It is possible to construct :class:`PartialFlowGraph` s -where this is not required but this will be covered in detail in :ref:`partial-flow-graph-java`. +As you can see, we use graph builder ``b`` to construct the graph using ``UniformFanOutShape`` and ``Flow``s. Once we have the +FlowGraph as result of ``closed()`` method *it is immutable, thread-safe, and freely shareable*. A graph can be ``run()`` directly - +assuming all ports (sinks/sources) within a flow have been connected properly. It is possible also to construct several :class:`PartialFlowGraph`s and +and then combine them into one fully connected graph. This will be covered in detail in :ref:`partial-flow-graph-java`. As all Akka Streams elements, :class:`Broadcast` will properly propagate back-pressure to its upstream element. diff --git a/akka-docs-dev/rst/scala/stream-quickstart.rst b/akka-docs-dev/rst/scala/stream-quickstart.rst index 57dc8e44a4..a9f167d850 100644 --- a/akka-docs-dev/rst/scala/stream-quickstart.rst +++ b/akka-docs-dev/rst/scala/stream-quickstart.rst @@ -24,7 +24,7 @@ Here's the data model we'll be working with throughout the quickstart examples: Transforming and consuming simple streams ----------------------------------------- -The example application we will be looking at is a simple Twitter fed stream from which we'll want to extract certain information, +The example application we will be looking at is a simple Twitter feed stream from which we'll want to extract certain information, like for example finding all twitter handles of users who tweet about ``#akka``. In order to prepare our environment by creating an :class:`ActorSystem` and :class:`ActorMaterializer`, diff --git a/akka-docs-dev/rst/stages-overview.rst b/akka-docs-dev/rst/stages-overview.rst index 3a79a113b6..90ffd01cd5 100644 --- a/akka-docs-dev/rst/stages-overview.rst +++ b/akka-docs-dev/rst/stages-overview.rst @@ -12,7 +12,7 @@ All stages stop and propagate the failure downstream as soon as any of their ups is used. This happens to ensure reliable teardown of streams and cleanup when failures happen. Failures are meant to be to model unrecoverable conditions, therefore they are always eagerly propagated. For in-band error handling of normal errors (dropping elements if a map fails for example) you should use the -upervision support, or explicitly wrap your element types in a proper container that can express error or success +supervision support, or explicitly wrap your element types in a proper container that can express error or success states (for example ``Try`` in Scala). Custom components are not covered by this table since their semantics are defined by the user.