From fc58fa1f0555f365ed5fcadc3b85f4c9026ccd7e Mon Sep 17 00:00:00 2001 From: Stefano Bonetti Date: Mon, 6 Jun 2016 10:28:04 +0100 Subject: [PATCH] Amending docs for KillSwitch #20708 (#20716) --- akka-docs/rst/java/stream/stream-dynamic.rst | 8 ++++---- akka-docs/rst/scala/stream/stream-dynamic.rst | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/akka-docs/rst/java/stream/stream-dynamic.rst b/akka-docs/rst/java/stream/stream-dynamic.rst index 77a0e0a436..f90cbdcacb 100644 --- a/akka-docs/rst/java/stream/stream-dynamic.rst +++ b/akka-docs/rst/java/stream/stream-dynamic.rst @@ -11,12 +11,12 @@ Controlling graph completion with KillSwitch A ``KillSwitch`` allows the completion of graphs of ``FlowShape`` from the outside. It consists of a flow element that can be linked to a graph of ``FlowShape`` needing completion control. -The ``KillSwitch`` trait allows to complete or fail the graph(s). +The ``KillSwitch`` interface allows to: -.. includecode:: ../../../../akka-stream/src/main/scala/akka/stream/KillSwitch.scala - :include: kill-switch +* complete the graph(s) via ``shutdown()`` +* fail the graph(s) via ``abort(Throwable error)`` -After the first call to either ``shutdown`` and ``abort``, all subsequent calls to any of these methods will be ignored. +After the first call to either ``shutdown`` or ``abort``, all subsequent calls to any of these methods will be ignored. Graph completion is performed by both * completing its downstream diff --git a/akka-docs/rst/scala/stream/stream-dynamic.rst b/akka-docs/rst/scala/stream/stream-dynamic.rst index 8716f934a6..cd4f5d6690 100644 --- a/akka-docs/rst/scala/stream/stream-dynamic.rst +++ b/akka-docs/rst/scala/stream/stream-dynamic.rst @@ -16,7 +16,7 @@ The ``KillSwitch`` trait allows to complete or fail the graph(s). .. includecode:: ../../../../akka-stream/src/main/scala/akka/stream/KillSwitch.scala :include: kill-switch -After the first call to either ``shutdown`` and ``abort``, all subsequent calls to any of these methods will be ignored. +After the first call to either ``shutdown`` or ``abort``, all subsequent calls to any of these methods will be ignored. Graph completion is performed by both * completing its downstream