@@ -20,25 +20,25 @@ import kotlin.coroutines.*
20
20
*/
21
21
public enum class CoroutineStart {
22
22
/* *
23
- * Default -- immediately schedules coroutine for execution according to its context.
23
+ * Default -- immediately schedules the coroutine for execution according to its context.
24
24
*
25
25
* If the [CoroutineDispatcher] of the coroutine context returns `true` from [CoroutineDispatcher.isDispatchNeeded]
26
26
* function as most dispatchers do, then the coroutine code is dispatched for execution later, while the code that
27
27
* invoked the coroutine builder continues execution.
28
28
*
29
29
* Note that [Dispatchers.Unconfined] always returns `false` from its [CoroutineDispatcher.isDispatchNeeded]
30
- * function, so starting coroutine with [Dispatchers.Unconfined] by [DEFAULT] is the same as using [UNDISPATCHED].
30
+ * function, so starting a coroutine with [Dispatchers.Unconfined] by [DEFAULT] is the same as using [UNDISPATCHED].
31
31
*
32
32
* If coroutine [Job] is cancelled before it even had a chance to start executing, then it will not start its
33
33
* execution at all, but will complete with an exception.
34
34
*
35
- * Cancellability of coroutine at suspension points depends on the particular implementation details of
35
+ * Cancellability of a coroutine at suspension points depends on the particular implementation details of
36
36
* suspending functions. Use [suspendCancellableCoroutine] to implement cancellable suspending functions.
37
37
*/
38
38
DEFAULT ,
39
39
40
40
/* *
41
- * Starts coroutine lazily, only when it is needed.
41
+ * Starts the coroutine lazily, only when it is needed.
42
42
*
43
43
* See the documentation for the corresponding coroutine builders for details
44
44
* (like [launch][CoroutineScope.launch] and [async][CoroutineScope.async]).
@@ -49,7 +49,7 @@ public enum class CoroutineStart {
49
49
LAZY ,
50
50
51
51
/* *
52
- * Atomically (i.e., in a non-cancellable way) schedules coroutine for execution according to its context.
52
+ * Atomically (i.e., in a non-cancellable way) schedules the coroutine for execution according to its context.
53
53
* This is similar to [DEFAULT], but the coroutine cannot be cancelled before it starts executing.
54
54
*
55
55
* Cancellability of coroutine at suspension points depends on the particular implementation details of
@@ -59,7 +59,7 @@ public enum class CoroutineStart {
59
59
ATOMIC ,
60
60
61
61
/* *
62
- * Immediately executes coroutine until its first suspension point _in the current thread_ as if the
62
+ * Immediately executes the coroutine until its first suspension point _in the current thread_ as if the
63
63
* coroutine was started using [Dispatchers.Unconfined]. However, when coroutine is resumed from suspension
64
64
* it is dispatched according to the [CoroutineDispatcher] in its context.
65
65
*
@@ -75,7 +75,7 @@ public enum class CoroutineStart {
75
75
UNDISPATCHED ;
76
76
77
77
/* *
78
- * Starts the corresponding block as a coroutine with this coroutine start strategy.
78
+ * Starts the corresponding block as a coroutine with this coroutine's start strategy.
79
79
*
80
80
* * [DEFAULT] uses [startCoroutineCancellable].
81
81
* * [ATOMIC] uses [startCoroutine].
0 commit comments