Skip to content

Commit e15970b

Browse files
authored
Fix Job.children docs (#2592)
Fixes #2566
1 parent cbf3f24 commit e15970b

File tree

1 file changed

+4
-5
lines changed
  • kotlinx-coroutines-core/common/src

1 file changed

+4
-5
lines changed

kotlinx-coroutines-core/common/src/Job.kt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -217,11 +217,10 @@ public interface Job : CoroutineContext.Element {
217217
* immediately cancels all its children.
218218
* * Parent cannot complete until all its children are complete. Parent waits for all its children to
219219
* complete in _completing_ or _cancelling_ state.
220-
* * Uncaught exception in a child, by default, cancels parent. In particular, this applies to
221-
* children created with [launch][CoroutineScope.launch] coroutine builder. Note that
222-
* [async][CoroutineScope.async] and other future-like
223-
* coroutine builders do not have uncaught exceptions by definition, since all their exceptions are
224-
* caught and are encapsulated in their result.
220+
* * Uncaught exception in a child, by default, cancels parent. This applies even to
221+
* children created with [async][CoroutineScope.async] and other future-like
222+
* coroutine builders, even though their exceptions are caught and are encapsulated in their result.
223+
* This default behavior can be overridden with [SupervisorJob].
225224
*/
226225
public val children: Sequence<Job>
227226

0 commit comments

Comments
 (0)