Improve supervisorScope KDoc
#2755
Closed
Conversation
This file contains hidden or 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
Previously, the KDoc wasn't explicit about the behaviour of `supervisorScope`, which is similar to the behaviour of the `coroutineScope` function. This was confusing (at least for me), for example here: https://kotlinlang.slack.com/archives/C1CFAFJSK/p1623338894383500?thread_ts=1623318861.372800&cid=C1CFAFJSK This commit intends to redirect the reader to the KDoc of `coroutineScope`, where all behaviour details are explained very well. The difference in behaviour is preserved, including the important reference to the `SupervisorJob` documentation.
|
Thanks for pointing it out! Rephrased our docs and opened #2757 |
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.
Previously, the KDoc wasn't explicit about the behaviour of
supervisorScope, which is similar to the behaviour of thecoroutineScopefunction.This was confusing (at least for me), for example here:
https://kotlinlang.slack.com/archives/C1CFAFJSK/p1623338894383500?thread_ts=1623318861.372800&cid=C1CFAFJSK
This commit intends to redirect the reader to the KDoc of
coroutineScope, where all behaviour details are explained very well.The difference in behaviour is preserved, including the important reference to the
SupervisorJobdocumentation.I ran
./gradlew knitsuccessfully locally, but there were no additional changes to commit.