Fix wrong docs on Job.join #2616
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Don't forget to change documentation for cancelAndJoin, it has the same statement. |
qwwdfsad
requested changes
Mar 30, 2021
| * In particular, it means that a parent coroutine invoking `join` on a child coroutine that was started using | ||
| * `launch(coroutineContext) { ... }` builder throws [CancellationException] if the child | ||
| * had crashed, unless a non-standard [CoroutineExceptionHandler] is installed in the context. | ||
| * In particular, it means that a parent coroutine invoking `join` on a child coroutine throws |
There was a problem hiding this comment.
I'd suggest removing the whole paragraph, now it seems to be redundant.
Also, please fix the same phrasing for cancelAndJoin
There was a problem hiding this comment.
I think this explanation still makes sense as it is quite counter-intuitive for people that you can crash an attempt to join another coroutine.
qwwdfsad
approved these changes
Apr 6, 2021
pablobaxter
pushed a commit
to pablobaxter/kotlinx.coroutines
that referenced
this pull request
Sep 14, 2022
* Fix wrong docs on Job.join and Job.cancelAndJoin Fixes Kotlin#2615
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2615