Update docstrings for ReadWriteLock tests (#12354)

Signed-off-by: Sean Quah <seanq@element.io>
matrix-org · Apr 5, 2022 · 9c4c499 · 9c4c499
1 parent 800ba87
commit 9c4c499
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/changelog.d/12354.misc 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
@@ -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.
@@ -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(
@@ -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(