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

Fix takeWhile description (#28703)

Browse source
This commit is contained in:
Christopher Batey 2020-03-09 16:15:48 +00:00 • committed by GitHub
parent 5b485be715
commit 0f77212913
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

7
akka-docs/src/main/paradox/stream/operators/Source-or-Flow/takeWhile.md
View file

@ -1,6 +1,6 @@
# takeWhile # takeWhile
Pass elements downstream as long as a predicate function return true for the element include the element when the predicate first return false and then complete. Pass elements downstream as long as a predicate function returns true and then complete.
@ref[Simple operators](../index.md#simple-operators) @ref[Simple operators](../index.md#simple-operators)
@ -14,8 +14,8 @@ Pass elements downstream as long as a predicate function return true for the ele
## Description ## Description
Pass elements downstream as long as a predicate function return true for the element include the element Pass elements downstream as long as a predicate function returns true and then complete.
when the predicate first return false and then complete. The element for which the predicate returns false is not emitted.
## Example ## Example
@ -36,4 +36,3 @@ Java
**completes** when predicate returned false or upstream completes **completes** when predicate returned false or upstream completes
@@@ @@@

2
akka-docs/src/main/paradox/stream/operators/index.md
View file

@ -178,7 +178,7 @@ depending on being backpressured by downstream or not.
|Source/Flow|<a name="sliding"></a>@ref[sliding](Source-or-Flow/sliding.md)|Provide a sliding window over the incoming stream and pass the windows as groups of elements downstream.| |Source/Flow|<a name="sliding"></a>@ref[sliding](Source-or-Flow/sliding.md)|Provide a sliding window over the incoming stream and pass the windows as groups of elements downstream.|
|Source/Flow|<a name="statefulmapconcat"></a>@ref[statefulMapConcat](Source-or-Flow/statefulMapConcat.md)|Transform each element into zero or more elements that are individually passed downstream.| |Source/Flow|<a name="statefulmapconcat"></a>@ref[statefulMapConcat](Source-or-Flow/statefulMapConcat.md)|Transform each element into zero or more elements that are individually passed downstream.|
|Source/Flow|<a name="take"></a>@ref[take](Source-or-Flow/take.md)|Pass `n` incoming elements downstream and then complete| |Source/Flow|<a name="take"></a>@ref[take](Source-or-Flow/take.md)|Pass `n` incoming elements downstream and then complete|
|Source/Flow|<a name="takewhile"></a>@ref[takeWhile](Source-or-Flow/takeWhile.md)|Pass elements downstream as long as a predicate function return true for the element include the element when the predicate first return false and then complete.| |Source/Flow|<a name="takewhile"></a>@ref[takeWhile](Source-or-Flow/takeWhile.md)|Pass elements downstream as long as a predicate function returns true and then complete. |
|Source/Flow|<a name="throttle"></a>@ref[throttle](Source-or-Flow/throttle.md)|Limit the throughput to a specific number of elements per time unit, or a specific total cost per time unit, where a function has to be provided to calculate the individual cost of each element.| |Source/Flow|<a name="throttle"></a>@ref[throttle](Source-or-Flow/throttle.md)|Limit the throughput to a specific number of elements per time unit, or a specific total cost per time unit, where a function has to be provided to calculate the individual cost of each element.|
|Source/Flow|<a name="watch"></a>@ref[watch](Source-or-Flow/watch.md)|Watch a specific `ActorRef` and signal a failure downstream once the actor terminates.| |Source/Flow|<a name="watch"></a>@ref[watch](Source-or-Flow/watch.md)|Watch a specific `ActorRef` and signal a failure downstream once the actor terminates.|

1
akka-docs/src/test/scala/docs/stream/operators/sourceorflow/TakeWhile.scala
View file

@ -13,6 +13,7 @@ object TakeWhile {
// #take-while // #take-while
Source(1 to 10).takeWhile(_ < 3).runForeach(println) Source(1 to 10).takeWhile(_ < 3).runForeach(println)
// prints
// 1 // 1
// 2 // 2
// #take-while // #take-while