From 882975e54674c2f0cb0d4fd9614adbf06a395c0a Mon Sep 17 00:00:00 2001 From: Patrik Nordwall Date: Fri, 24 Apr 2015 14:59:29 +0200 Subject: [PATCH] =str minor doc syntax correction --- akka-docs-dev/rst/java/stream-graphs.rst | 4 ++-- akka-docs-dev/rst/java/stream-quickstart.rst | 3 +-- akka-docs-dev/rst/scala/stream-graphs.rst | 4 ++-- akka-docs-dev/rst/scala/stream-quickstart.rst | 3 +-- 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/akka-docs-dev/rst/java/stream-graphs.rst b/akka-docs-dev/rst/java/stream-graphs.rst index 4f447c4590..c9e6d89e60 100644 --- a/akka-docs-dev/rst/java/stream-graphs.rst +++ b/akka-docs-dev/rst/java/stream-graphs.rst @@ -155,13 +155,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:: ../../../akka-samples/akka-docs-java-lambda/src/test/java/docs/stream/BidiFlowDocTest.java diff --git a/akka-docs-dev/rst/java/stream-quickstart.rst b/akka-docs-dev/rst/java/stream-quickstart.rst index f7dc5b36f6..4e780b23e4 100644 --- a/akka-docs-dev/rst/java/stream-quickstart.rst +++ b/akka-docs-dev/rst/java/stream-quickstart.rst @@ -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-java`), the dispatcher to -be used by the pipeline etc. These can be overridden on a flow, source and sink, 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`: diff --git a/akka-docs-dev/rst/scala/stream-graphs.rst b/akka-docs-dev/rst/scala/stream-graphs.rst index 4f638760e1..27f36539cc 100644 --- a/akka-docs-dev/rst/scala/stream-graphs.rst +++ b/akka-docs-dev/rst/scala/stream-graphs.rst @@ -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 diff --git a/akka-docs-dev/rst/scala/stream-quickstart.rst b/akka-docs-dev/rst/scala/stream-quickstart.rst index 2ab04e163e..74b1cd56a6 100644 --- a/akka-docs-dev/rst/scala/stream-quickstart.rst +++ b/akka-docs-dev/rst/scala/stream-quickstart.rst @@ -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]`: