Skip to content

Commit

Permalink
Remove duplicate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Serious-senpai committed Sep 14, 2024
1 parent 8bd4c12 commit 041ba4c
Showing 1 changed file with 0 additions and 27 deletions.
27 changes: 0 additions & 27 deletions lib/src/lock.dart
Original file line number Diff line number Diff line change
@@ -1,32 +1,5 @@
part of "../async_locks.dart";

/// Mutex lock to guarantee exclusive access to a shared state.
///
/// A [Lock] object can be in one of two states: "locked" or "unlocked".
///
/// If the lock is "locked", all futures that call [acquire] will be put in a waiting FIFO queue
/// and will proceed in order for each [release] call.
///
/// If the lock is "unlocked", calling [acquire] will set the lock to the "locked" state and
/// return immediately.
///
/// Example usage:
/// ```dart
/// final lock = Lock();
///
/// // Acquire the lock
/// await lock.acquire();
///
/// try {
/// // Perform exclusive operations on the shared state
/// // ...
/// } finally {
/// // Release the lock
/// lock.release();
/// }
/// ```
///
/// See also: [Python documentation](https://docs.python.org/3/library/asyncio-sync.html#asyncio.Lock)
/// Mutex lock to guarantee exclusive access to a shared state.
///
/// A [Lock] object can be in one of two states: "locked" or "unlocked".
Expand Down

0 comments on commit 041ba4c

Please sign in to comment.