diff options
author | Dmitry Khalanskiy <52952525+dkhalanskyjb@users.noreply.github.com> | 2024-01-30 15:01:53 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-30 15:01:53 +0300 |
commit | be781c50bab3758fa5da2897c3aff551d39af4f6 (patch) | |
tree | 36f44f6e01266888f4db6fb27a201e61b44c7b43 /kotlinx-coroutines-core/common/src/CompletionHandler.common.kt | |
parent | 2b69cf0c666917f34589cdd880d0e41b530a8c7e (diff) | |
download | kotlinx.coroutines-be781c50bab3758fa5da2897c3aff551d39af4f6.tar.gz |
Use dashes instead of asterisks for lists in KDoc (#4027)
* Replace `*` with `-` everywhere in KDoc
git grep -l '\* \+\* ' | xargs -n1 sed -i 's/^\([ \t]*\* \+\)\* /\1- /'
* Fix several false positives of the regex replacement
Diffstat (limited to 'kotlinx-coroutines-core/common/src/CompletionHandler.common.kt')
-rw-r--r-- | kotlinx-coroutines-core/common/src/CompletionHandler.common.kt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/kotlinx-coroutines-core/common/src/CompletionHandler.common.kt b/kotlinx-coroutines-core/common/src/CompletionHandler.common.kt index 31e28936..54c5a936 100644 --- a/kotlinx-coroutines-core/common/src/CompletionHandler.common.kt +++ b/kotlinx-coroutines-core/common/src/CompletionHandler.common.kt @@ -9,10 +9,10 @@ import kotlinx.coroutines.internal.* * wrapped into [CompletionHandlerException], and rethrown, potentially causing crash of unrelated code. * * The meaning of `cause` that is passed to the handler: - * * Cause is `null` when the job has completed normally. - * * Cause is an instance of [CancellationException] when the job was cancelled _normally_. + * - Cause is `null` when the job has completed normally. + * - Cause is an instance of [CancellationException] when the job was cancelled _normally_. * **It should not be treated as an error**. In particular, it should not be reported to error logs. - * * Otherwise, the job had _failed_. + * - Otherwise, the job had _failed_. * * **Note**: This type is a part of internal machinery that supports parent-child hierarchies * and allows for implementation of suspending functions that wait on the Job's state. |