From c7ac49852053de7c862e3b0c541e5edc20f35f48 Mon Sep 17 00:00:00 2001 From: Jim Riordan Date: Tue, 11 Jul 2017 22:30:52 +1000 Subject: [PATCH] Fix documentation for Unzip class (#23333) (#23334) --- .../scala/akka/stream/scaladsl/Graph.scala | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/akka-stream/src/main/scala/akka/stream/scaladsl/Graph.scala b/akka-stream/src/main/scala/akka/stream/scaladsl/Graph.scala index c470cfef62..036c0d15ec 100644 --- a/akka-stream/src/main/scala/akka/stream/scaladsl/Graph.scala +++ b/akka-stream/src/main/scala/akka/stream/scaladsl/Graph.scala @@ -877,9 +877,9 @@ object ZipWith extends ZipWithApply * * An `Unzip` has one `in` port and one `left` and one `right` output port. * - * '''Emits when''' all of the outputs stops backpressuring and there is an input element available + * '''Emits when''' all of the outputs stop backpressuring and there is an input element available * - * '''Backpressures when''' any of the outputs backpressures + * '''Backpressures when''' any of the outputs backpressure * * '''Completes when''' upstream completes * @@ -893,7 +893,17 @@ object Unzip { } /** - * Combine the elements of multiple streams into a stream of the combined elements. + * Takes a stream of pair elements and splits each pair to two output streams. + * + * An `Unzip` has one `in` port and one `left` and one `right` output port. + * + * '''Emits when''' all of the outputs stop backpressuring and there is an input element available + * + * '''Backpressures when''' any of the outputs backpressure + * + * '''Completes when''' upstream completes + * + * '''Cancels when''' any downstream cancels */ final class Unzip[A, B]() extends UnzipWith2[(A, B), A, B](ConstantFun.scalaIdentityFunction) { override def toString = "Unzip" @@ -902,9 +912,9 @@ final class Unzip[A, B]() extends UnzipWith2[(A, B), A, B](ConstantFun.scalaIden /** * Transforms each element of input stream into multiple streams using a splitter function. * - * '''Emits when''' all of the outputs stops backpressuring and there is an input element available + * '''Emits when''' all of the outputs stop backpressuring and there is an input element available * - * '''Backpressures when''' any of the outputs backpressures + * '''Backpressures when''' any of the outputs backpressure * * '''Completes when''' upstream completes *