Skip to content

Commit 1704220

Browse files
committed
Move some tables from top-level to package-level API references
1 parent f7d7034 commit 1704220

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

kotlinx-coroutines-core/README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,22 @@ helper function.
5353
The [NonCancellable] job object is provided to suppress cancellation inside the
5454
`withContext(NonCancellable) {...}` block of code.
5555

56+
# Package kotlinx.coroutines
57+
58+
General-purpose coroutine builders, contexts, and helper functions.
59+
60+
# Package kotlinx.coroutines.sync
61+
62+
Synchronization primitives (mutex and semaphore).
63+
64+
# Package kotlinx.coroutines.channels
65+
66+
Channels — non-blocking primitives for communicating a stream of elements between coroutines.
67+
68+
# Package kotlinx.coroutines.flow
69+
70+
Flow — asynchronous cold and hot streams of elements.
71+
5672
Ways to construct asynchronous streams of values:
5773

5874
| **Name** | **Type** | **Description**
@@ -69,7 +85,9 @@ Ways to construct asynchronous streams of values:
6985
A *cold* stream is some process of generating values, and this process is performed separately for each subscriber.
7086
A *hot* stream uses the same source of values independently of whether there are subscribers.
7187

72-
A [select][kotlinx.coroutines.selects.select] expression waits for the result of multiple suspending functions simultaneously:
88+
# Package kotlinx.coroutines.selects
89+
90+
[Select][kotlinx.coroutines.selects.select] — expressions that perform multiple suspending operations simultaneously until one of them succeeds.
7391

7492
| **Receiver** | **Suspending function** | **Select clause** | **Non-suspending version**
7593
| ------------------------------------------------------------ | --------------------------------------------------------------- | ----------------------------------------------------------------- | --------------------------
@@ -80,26 +98,6 @@ A [select][kotlinx.coroutines.selects.select] expression waits for the result of
8098
| [ReceiveChannel][kotlinx.coroutines.channels.ReceiveChannel] | [receiveCatching][kotlinx.coroutines.channels.receiveCatching] | [onReceiveCatching][kotlinx.coroutines.channels.onReceiveCatching] | [tryReceive][kotlinx.coroutines.channels.ReceiveChannel.tryReceive]
8199
| none | [delay][kotlinx.coroutines.delay] | [onTimeout][kotlinx.coroutines.selects.SelectBuilder.onTimeout] | none
82100

83-
# Package kotlinx.coroutines
84-
85-
General-purpose coroutine builders, contexts, and helper functions.
86-
87-
# Package kotlinx.coroutines.sync
88-
89-
Synchronization primitives (mutex and semaphore).
90-
91-
# Package kotlinx.coroutines.channels
92-
93-
Channels — non-blocking primitives for communicating a stream of elements between coroutines.
94-
95-
# Package kotlinx.coroutines.flow
96-
97-
Flow — asynchronous cold and hot streams of elements.
98-
99-
# Package kotlinx.coroutines.selects
100-
101-
Select — expressions that perform multiple suspending operations simultaneously until one of them succeeds.
102-
103101
# Package kotlinx.coroutines.intrinsics
104102

105103
Low-level primitives for finer-grained control of coroutines.

0 commit comments

Comments
 (0)