Small documentation fixes #4042
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
lukellmann
reviewed
Feb 12, 2024
dkhalanskyjb
force-pushed
the
dk-doc-improvements
branch
from
be88d19
to
ee18ce2
Compare
qwwdfsad
reviewed
Feb 14, 2024
dkhalanskyjb
force-pushed
the
dk-doc-improvements
branch
2 times, most recently
from
794a782
to
d190857
Compare
A user raised a concern that the internal coroutines machinery may break if `runBlocking` is used somewhere deeply in the call stack. Calling `runBlocking` from a `suspend` functions can lead to deadlocks naturally due to blocking the thread, or to surprising event ordering, but nothing is expected to break. This commit clarifies the exact danger of calling `runBlocking` from `suspend` functions.
Fixes two issues: * It is surprising for some users that the same exception can be thrown several times. Clarified this point explicitly. * Due to #3658, `await` can throw `CancellationException` in several cases: when the `await` call is cancelled, or when the `Deferred` is cancelled. This is clarified with an example of how to handle this. Fixes #3937
Emphasize the fact that the function fails to resume *even if it already completed* but wasn't dispatched yet. Before the change, when translating the documentation to Chinese, there could be a confusion as to what "it will not resume successfully" means. Fixes #3888
What does it even mean?
Seems like a lot of the information was outdated. Fixes #3725
dkhalanskyjb
force-pushed
the
dk-doc-improvements
branch
from
d190857
to
83fa0b4
Compare
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.
No description provided.