Skip to content

Commit

Permalink
Cleanup outdated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
qwwdfsad committed Apr 4, 2019
1 parent d449052 commit ffae070
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 19 deletions.
4 changes: 4 additions & 0 deletions kotlinx-coroutines-core/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ terminate in near zero time. See the documentation for this class for more infor

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

# Package kotlinx.coroutines.flow

Flow -- primitive to work with asynchronous and event-based streams of data.

# Package kotlinx.coroutines.sync

Synchronization primitives (mutex).
Expand Down
20 changes: 1 addition & 19 deletions kotlinx-coroutines-core/common/src/flow/Flow.kt
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,7 @@ import kotlinx.coroutines.*
* println("Flow has thrown an exception: $e")
* }
* ```
* Additionally, the library provides a rich set of terminal operators in `kotlinx.coroutines.flow.terminal`, such as
* [single], [reduce] and others.
*
* Flow also can be collected asynchronously using launch-like coroutine:
* ```
* flow.launchIn(uiScope) {
* onEach { value ->
* println("Received $value")
* }
*
* catch<MyException> {
* println("Flow has failed")
* }
*
* finally {
* println("Doing cleanup)
* }
* }
* ```
* Additionally, the library provides a rich set of terminal operators such as [single], [reduce] and others.
*
* Flow does not carry information whether it is a cold stream (that can be collected multiple times and
* triggers its evaluation every time collection is executed) or hot one, but conventionally flow represents a cold stream.
Expand Down

0 comments on commit ffae070

Please sign in to comment.