Skip to content

Commit

Permalink
Clarify documentation of Mutex.lock() behavior (#3816)
Browse files Browse the repository at this point in the history
  • Loading branch information
obermillerk authored Jul 20, 2023
1 parent 5c4a252 commit 9b06a69
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion kotlinx-coroutines-core/common/src/sync/Mutex.kt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public interface Mutex {
public fun tryLock(owner: Any? = null): Boolean

/**
* Locks this mutex, suspending caller while the mutex is locked.
* Locks this mutex, suspending caller until the lock is acquired (in other words, while the lock is held elsewhere).
*
* This suspending function is cancellable. If the [Job] of the current coroutine is cancelled or completed while this
* function is suspended, this function immediately resumes with [CancellationException].
Expand Down

0 comments on commit 9b06a69

Please sign in to comment.