Skip to content

Commit ffae070

Browse files
committed
Cleanup outdated documentation
1 parent d449052 commit ffae070

File tree

2 files changed

+5
-19
lines changed

2 files changed

+5
-19
lines changed

kotlinx-coroutines-core/common/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ terminate in near zero time. See the documentation for this class for more infor
7676

7777
General-purpose coroutine builders, contexts, and helper functions.
7878

79+
# Package kotlinx.coroutines.flow
80+
81+
Flow -- primitive to work with asynchronous and event-based streams of data.
82+
7983
# Package kotlinx.coroutines.sync
8084

8185
Synchronization primitives (mutex).

kotlinx-coroutines-core/common/src/flow/Flow.kt

+1-19
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,7 @@ import kotlinx.coroutines.*
2323
* println("Flow has thrown an exception: $e")
2424
* }
2525
* ```
26-
* Additionally, the library provides a rich set of terminal operators in `kotlinx.coroutines.flow.terminal`, such as
27-
* [single], [reduce] and others.
28-
*
29-
* Flow also can be collected asynchronously using launch-like coroutine:
30-
* ```
31-
* flow.launchIn(uiScope) {
32-
* onEach { value ->
33-
* println("Received $value")
34-
* }
35-
*
36-
* catch<MyException> {
37-
* println("Flow has failed")
38-
* }
39-
*
40-
* finally {
41-
* println("Doing cleanup)
42-
* }
43-
* }
44-
* ```
26+
* Additionally, the library provides a rich set of terminal operators such as [single], [reduce] and others.
4527
*
4628
* Flow does not carry information whether it is a cold stream (that can be collected multiple times and
4729
* triggers its evaluation every time collection is executed) or hot one, but conventionally flow represents a cold stream.

0 commit comments

Comments
 (0)