Skip to content

Commit

Permalink
Fix Job.children docs (#2592)
Browse files Browse the repository at this point in the history
Fixes #2566
  • Loading branch information
elizarov committed Mar 18, 2021
1 parent cbf3f24 commit e15970b
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions kotlinx-coroutines-core/common/src/Job.kt
Original file line number Diff line number Diff line change
Expand Up @@ -217,11 +217,10 @@ public interface Job : CoroutineContext.Element {
* immediately cancels all its children.
* * Parent cannot complete until all its children are complete. Parent waits for all its children to
* complete in _completing_ or _cancelling_ state.
* * Uncaught exception in a child, by default, cancels parent. In particular, this applies to
* children created with [launch][CoroutineScope.launch] coroutine builder. Note that
* [async][CoroutineScope.async] and other future-like
* coroutine builders do not have uncaught exceptions by definition, since all their exceptions are
* caught and are encapsulated in their result.
* * Uncaught exception in a child, by default, cancels parent. This applies even to
* children created with [async][CoroutineScope.async] and other future-like
* coroutine builders, even though their exceptions are caught and are encapsulated in their result.
* This default behavior can be overridden with [SupervisorJob].
*/
public val children: Sequence<Job>

Expand Down

0 comments on commit e15970b

Please sign in to comment.