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

=str minor doc syntax correction

Browse source
This commit is contained in:
Patrik Nordwall 2015-04-24 14:59:29 +02:00
parent eb4cb47762
commit 882975e546
4 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
akka-docs-dev/rst/scala/stream-graphs.rst
View file

@ -209,13 +209,13 @@ frames back into the original octet stream chunks. These two stages are meant
to be composed, applying one atop the other as part of a protocol stack. For
this purpose exists the special type :class:`BidiFlow` which is a graph that
has exactly two open inlets and two open outlets. The corresponding shape is
called :ref:`BidiShape` and is defined like this:
called :class:`BidiShape` and is defined like this:
.. includecode:: ../../../akka-stream/src/main/scala/akka/stream/Shape.scala
:include: bidi-shape
:exclude: implementation-details-elided
A bidirectional flow is defined just like a unidirectional :ref:`Flow` as
A bidirectional flow is defined just like a unidirectional :class:`Flow` as
demonstrated for the codec mentioned above:
.. includecode:: code/docs/stream/BidiFlowDocSpec.scala

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

@ -26,8 +26,7 @@ which will be responsible for materializing and running the streams we are about
The :class:`ActorFlowMaterializer` can optionally take :class:`ActorFlowMaterializerSettings` which can be used to define
materialization properties, such as default buffer sizes (see also :ref:`stream-buffers-scala`), the dispatcher to
be used by the pipeline etc. These can be overridden on an element-by-element basis or for an entire section, but this
will be discussed in depth in :ref:`stream-section-configuration`.
be used by the pipeline etc. These can be overridden ``withAttributes`` on :class:`Flow`, :class:`Source`, :class:`Sink` and :class:`Graph`.
Let's assume we have a stream of tweets readily available, in Akka this is expressed as a :class:`Source[Out, M]`: