Skip to content

Update CoroutineScope() factory documentation #2892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 2, 2021
Merged

Conversation

qwwdfsad
Copy link
Member

Fixes #2891

@qwwdfsad qwwdfsad requested a review from dkhalanskyjb August 23, 2021 12:35
Copy link
Collaborator

@dkhalanskyjb dkhalanskyjb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.

just like inside [coroutineScope] block.

Maybe it's also worth it to explicitly mention in the coroutineScope documentation that cancelling the scope also cancels the children? The only mention of this behaviour that I see is fairly indirect:

    1. If the outer scope of showSomeData is cancelled, both started async and withContext blocks are cancelled.

@qwwdfsad
Copy link
Member Author

qwwdfsad commented Sep 2, 2021

Honestly, I do not see how it can be fit organically.

We have quite extensive documentation in CoroutineScope and Job, while the rest of the builders (whether it is async or withContext) point to it. Not sure it's worth repeating in every declaration

@qwwdfsad qwwdfsad merged commit 9530760 into develop Sep 2, 2021
@qwwdfsad qwwdfsad deleted the fix-scope-docs branch September 2, 2021 11:16
pablobaxter pushed a commit to pablobaxter/kotlinx.coroutines that referenced this pull request Sep 14, 2022
* Update CoroutineScope() factory documentation

Fixes Kotlin#2891
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants