Skip to content

Commit

Permalink
Minor documentation fixes (#3762)
Browse files Browse the repository at this point in the history
* Remove unnecessary newline (#3756)
* Properly name Flow.timeout param in the documentation


---------

Co-authored-by: Hanbit Kang <[email protected]>
  • Loading branch information
pablobaxter and hanbikan authored Jun 22, 2023
1 parent 1074e33 commit c5ce96a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
3 changes: 1 addition & 2 deletions docs/topics/shared-mutable-state-and-concurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!--- CLEAR -->

Expand Down
2 changes: 1 addition & 1 deletion kotlinx-coroutines-core/common/src/flow/operators/Delay.kt
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ public fun <T> Flow<T>.sample(period: Duration): Flow<T> = 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 <T> Flow<T>.timeout(
Expand Down

0 comments on commit c5ce96a

Please sign in to comment.