From c5ce96a9bfb3a912c2acebddd013c410e84da5b6 Mon Sep 17 00:00:00 2001 From: Pablo Baxter Date: Thu, 22 Jun 2023 12:22:09 -0700 Subject: [PATCH] Minor documentation fixes (#3762) * Remove unnecessary newline (#3756) * Properly name Flow.timeout param in the documentation --------- Co-authored-by: Hanbit Kang <58168528+hanbikan@users.noreply.github.com> --- docs/topics/shared-mutable-state-and-concurrency.md | 3 +-- kotlinx-coroutines-core/common/src/flow/operators/Delay.kt | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/topics/shared-mutable-state-and-concurrency.md b/docs/topics/shared-mutable-state-and-concurrency.md index 8b840a23d9..fad13d64bc 100644 --- a/docs/topics/shared-mutable-state-and-concurrency.md +++ b/docs/topics/shared-mutable-state-and-concurrency.md @@ -195,8 +195,7 @@ state or to complex operations that do not have ready-to-use thread-safe impleme _Thread confinement_ is an approach to the problem of shared mutable state where all access to the particular shared state is confined to a single thread. It is typically used in UI applications, where all UI state is confined to -the single event-dispatch/application thread. It is easy to apply with coroutines by using a -single-threaded context. +the single event-dispatch/application thread. It is easy to apply with coroutines by using a single-threaded context. diff --git a/kotlinx-coroutines-core/common/src/flow/operators/Delay.kt b/kotlinx-coroutines-core/common/src/flow/operators/Delay.kt index 738fef79be..37505dc162 100644 --- a/kotlinx-coroutines-core/common/src/flow/operators/Delay.kt +++ b/kotlinx-coroutines-core/common/src/flow/operators/Delay.kt @@ -376,7 +376,7 @@ public fun Flow.sample(period: Duration): Flow = sample(period.toDelay * * Note that delaying on the downstream doesn't trigger the timeout. * - * @param timeout period. If non-positive, the flow is timed out immediately + * @param timeout Timeout duration. If non-positive, the flow is timed out immediately */ @FlowPreview public fun Flow.timeout(