From d0d54212ddca995c63918ac40b7deadc99686a8c Mon Sep 17 00:00:00 2001 From: Konrad `ktoso` Malawski Date: Thu, 20 Sep 2018 13:01:24 +0900 Subject: [PATCH] add TODOs to encourage contributing operator examples (#25478) --- .../src/main/paradox/stream/operators/FileIO/toPath.md | 3 +++ .../src/main/paradox/stream/operators/Sink/asPublisher.md | 4 ++++ .../main/paradox/stream/operators/Sink/fromSubscriber.md | 3 +++ .../paradox/stream/operators/Source-or-Flow/collectType.md | 3 +++ .../main/paradox/stream/operators/Source/asSubscriber.md | 7 +------ .../main/paradox/stream/operators/Source/fromPublisher.md | 3 +++ .../stream/operators/StreamConverters/fromInputStream.md | 7 +------ .../stream/operators/StreamConverters/fromJavaStream.md | 3 +++ .../stream/operators/StreamConverters/fromOutputStream.md | 3 +++ .../stream/operators/StreamConverters/javaCollector.md | 7 +------ .../StreamConverters/javaCollectorParallelUnordered.md | 7 +------ 11 files changed, 26 insertions(+), 24 deletions(-) diff --git a/akka-docs/src/main/paradox/stream/operators/FileIO/toPath.md b/akka-docs/src/main/paradox/stream/operators/FileIO/toPath.md index 8c1e1bbb57..b8bbfb2b16 100644 --- a/akka-docs/src/main/paradox/stream/operators/FileIO/toPath.md +++ b/akka-docs/src/main/paradox/stream/operators/FileIO/toPath.md @@ -12,3 +12,6 @@ Create a sink which will write incoming `ByteString` s to a given file path. @@@ +## Description + +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/Sink/asPublisher.md b/akka-docs/src/main/paradox/stream/operators/Sink/asPublisher.md index e9b4ada7a5..d41338ff24 100644 --- a/akka-docs/src/main/paradox/stream/operators/Sink/asPublisher.md +++ b/akka-docs/src/main/paradox/stream/operators/Sink/asPublisher.md @@ -5,6 +5,7 @@ Integration with Reactive Streams, materializes into a `org.reactivestreams.Publ @ref[Sink operators](../index.md#sink-operators) @@@ div { .group-scala } + ## Signature @@signature [Sink.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Sink.scala) { #asPublisher } @@ -12,3 +13,6 @@ Integration with Reactive Streams, materializes into a `org.reactivestreams.Publ @@@ +## Description + +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/Sink/fromSubscriber.md b/akka-docs/src/main/paradox/stream/operators/Sink/fromSubscriber.md index 5fd29995e5..e0ab946157 100644 --- a/akka-docs/src/main/paradox/stream/operators/Sink/fromSubscriber.md +++ b/akka-docs/src/main/paradox/stream/operators/Sink/fromSubscriber.md @@ -12,3 +12,6 @@ Integration with Reactive Streams, wraps a `org.reactivestreams.Subscriber` as a @@@ +## Description + +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/collectType.md b/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/collectType.md index 897052535b..9327761a5f 100644 --- a/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/collectType.md +++ b/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/collectType.md @@ -14,3 +14,6 @@ Transform this stream by testing the type of each of the elements on which the e +## Description + +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/Source/asSubscriber.md b/akka-docs/src/main/paradox/stream/operators/Source/asSubscriber.md index e5040483ee..4e6ac43f05 100644 --- a/akka-docs/src/main/paradox/stream/operators/Source/asSubscriber.md +++ b/akka-docs/src/main/paradox/stream/operators/Source/asSubscriber.md @@ -12,9 +12,4 @@ Integration with Reactive Streams, materializes into a `org.reactivestreams.Subs ## Description - - -@@@div { .callout } - -@@@ - +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/Source/fromPublisher.md b/akka-docs/src/main/paradox/stream/operators/Source/fromPublisher.md index b6929add0e..511834d145 100644 --- a/akka-docs/src/main/paradox/stream/operators/Source/fromPublisher.md +++ b/akka-docs/src/main/paradox/stream/operators/Source/fromPublisher.md @@ -12,3 +12,6 @@ Integration with Reactive Streams, subscribes to a `org.reactivestreams.Publishe @@@ +## Description + +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromInputStream.md b/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromInputStream.md index e0ab09dd45..5b948ac8dc 100644 --- a/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromInputStream.md +++ b/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromInputStream.md @@ -14,9 +14,4 @@ Create a source that wraps an `InputStream`. ## Description - - -@@@div { .callout } - -@@@ - +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromJavaStream.md b/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromJavaStream.md index dfa7eba5c8..6f7135c7f3 100644 --- a/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromJavaStream.md +++ b/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromJavaStream.md @@ -12,3 +12,6 @@ Create a source that wraps a Java 8 `Stream`. @@@ +## Description + +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md b/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md index 4cf465d4aa..cfd80de7da 100644 --- a/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md +++ b/akka-docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md @@ -12,3 +12,6 @@ Create a sink that wraps an `OutputStream`. @@@ +## Description + +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollector.md b/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollector.md index 2831e9e2f5..0094584b63 100644 --- a/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollector.md +++ b/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollector.md @@ -14,9 +14,4 @@ Create a sink which materializes into a @scala[`Future`] @java[`CompletionStage` ## Description - - -@@@div { .callout } - -@@@ - +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646 diff --git a/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollectorParallelUnordered.md b/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollectorParallelUnordered.md index 40fc635734..c8e0bf3b3c 100644 --- a/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollectorParallelUnordered.md +++ b/akka-docs/src/main/paradox/stream/operators/StreamConverters/javaCollectorParallelUnordered.md @@ -14,9 +14,4 @@ Create a sink which materializes into a @scala[`Future`] @java[`CompletionStage` ## Description - - -@@@div { .callout } - -@@@ - +TODO: We would welcome help on contributing descriptions and examples, see: https://github.com/akka/akka/issues/25646