raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

=str #18378 Small typos in Streams docs

Browse source
This commit is contained in:
Alexander Golubev 2015-09-18 10:02:09 -04:00
parent e713591e5f
commit c066ce4a8a
3 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
akka-docs-dev/rst/java/stream-quickstart.rst
View file

@ -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.

2
akka-docs-dev/rst/scala/stream-quickstart.rst
View file

@ -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`,

2
akka-docs-dev/rst/stages-overview.rst
View file

@ -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.