Skip to content

Commit 9b06a69

Browse files
authored
Clarify documentation of Mutex.lock() behavior (#3816)
1 parent 5c4a252 commit 9b06a69

File tree

1 file changed

+1
-1
lines changed
  • kotlinx-coroutines-core/common/src/sync

1 file changed

+1
-1
lines changed

kotlinx-coroutines-core/common/src/sync/Mutex.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public interface Mutex {
4242
public fun tryLock(owner: Any? = null): Boolean
4343

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

0 commit comments

Comments
 (0)