diff options
| -rw-r--r-- | changelog.d/12354.misc | 1 | ||||
| -rw-r--r-- | tests/util/test_rwlock.py | 12 |
2 files changed, 7 insertions, 6 deletions
diff --git a/changelog.d/12354.misc b/changelog.d/12354.misc new file mode 100644 index 0000000000..e3b8950faa --- /dev/null +++ b/changelog.d/12354.misc @@ -0,0 +1 @@ +Update docstrings for `ReadWriteLock` tests. diff --git a/tests/util/test_rwlock.py b/tests/util/test_rwlock.py index 0c84226197..5da04362a9 100644 --- a/tests/util/test_rwlock.py +++ b/tests/util/test_rwlock.py @@ -40,8 +40,8 @@ class ReadWriteLockTestCase(unittest.TestCase): 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. @@ -87,8 +87,8 @@ class ReadWriteLockTestCase(unittest.TestCase): 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( @@ -106,8 +106,8 @@ class ReadWriteLockTestCase(unittest.TestCase): 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( |