Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update docstrings for ReadWriteLock tests #12354

Merged
merged 1 commit into from
Apr 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/12354.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update docstrings for `ReadWriteLock` tests.
12 changes: 6 additions & 6 deletions tests/util/test_rwlock.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ def _start_reader_or_writer(

Returns:
A tuple of three `Deferred`s:
* A `Deferred` that resolves with `return_value` once the reader or writer
completes successfully.
* A cancellable `Deferred` for the entire read or write operation that
resolves with `return_value` on successful completion.
* A `Deferred` that resolves once the reader or writer acquires the lock.
* A `Deferred` that blocks the reader or writer. Must be resolved by the
caller to allow the reader or writer to release the lock and complete.
Expand Down Expand Up @@ -87,8 +87,8 @@ def _start_nonblocking_reader(

Returns:
A tuple of two `Deferred`s:
* A `Deferred` that resolves with `return_value` once the reader completes
successfully.
* A cancellable `Deferred` for the entire read operation that resolves with
`return_value` on successful completion.
* A `Deferred` that resolves once the reader acquires the lock.
"""
d, acquired_d, unblock_d = self._start_reader_or_writer(
Expand All @@ -106,8 +106,8 @@ def _start_nonblocking_writer(

Returns:
A tuple of two `Deferred`s:
* A `Deferred` that resolves with `return_value` once the writer completes
successfully.
* A cancellable `Deferred` for the entire write operation that resolves
with `return_value` on successful completion.
* A `Deferred` that resolves once the writer acquires the lock.
"""
d, acquired_d, unblock_d = self._start_reader_or_writer(
Expand Down