Update CancellableContinuation documentation #4268
Conversation
| */ | ||
| public val isCompleted: Boolean | ||
|
|
||
| /** | ||
| * Returns `true` if this continuation was [cancelled][cancel]. | ||
| * Returns `true` if this continuation was [cancelled][CancellableContinuation.cancel]. |
There was a problem hiding this comment.
Why is this needed? Do we need to introduce such a fix throughout the documentation of every class/interface referring to its other members? I hope not: if just writing [cancel] is problematic, to me, this looks like a bug in our documentation tooling.
There was a problem hiding this comment.
I wanted to be more explicit, I can revert that if you believe it's important.
I.e. it could've been some top-level cancel, too much of a context to process at once
There was a problem hiding this comment.
If it's just a stylistic choice (that no one except the ones reading pure KDoc text will see?), it's not important to me either way, but if this is needed for the link to correctly resolve, that's alarming.
| * | ||
| * Cancellable continuation has three states (as subset of [Job] states): | ||
| * [CancellableContinuation] provides the capability to work with values that represent a resource that should be | ||
| * closed. For that, it provides `resume(value: R, onCancellation: ((cause: Throwable, value: R, context: CoroutineContext) -> Unit)` |
There was a problem hiding this comment.
| * closed. For that, it provides `resume(value: R, onCancellation: ((cause: Throwable, value: R, context: CoroutineContext) -> Unit)` | |
| * closed. For that, it provides `resume(value: R, onCancellation: ((cause: Throwable, value: R, context: CoroutineContext) -> Unit)?)` |
No description provided.