mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-09-07 22:22:06 +00:00
Update docstrings for ReadWriteLock
tests (#12354)
Signed-off-by: Sean Quah <seanq@element.io>
This commit is contained in:
parent
800ba87cc8
commit
9c4c49991d
1
changelog.d/12354.misc
Normal file
1
changelog.d/12354.misc
Normal file
@ -0,0 +1 @@
|
|||||||
|
Update docstrings for `ReadWriteLock` tests.
|
@ -40,8 +40,8 @@ class ReadWriteLockTestCase(unittest.TestCase):
|
|||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
A tuple of three `Deferred`s:
|
A tuple of three `Deferred`s:
|
||||||
* A `Deferred` that resolves with `return_value` once the reader or writer
|
* A cancellable `Deferred` for the entire read or write operation that
|
||||||
completes successfully.
|
resolves with `return_value` on successful completion.
|
||||||
* A `Deferred` that resolves once the reader or writer acquires the lock.
|
* 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
|
* 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.
|
caller to allow the reader or writer to release the lock and complete.
|
||||||
@ -87,8 +87,8 @@ class ReadWriteLockTestCase(unittest.TestCase):
|
|||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
A tuple of two `Deferred`s:
|
A tuple of two `Deferred`s:
|
||||||
* A `Deferred` that resolves with `return_value` once the reader completes
|
* A cancellable `Deferred` for the entire read operation that resolves with
|
||||||
successfully.
|
`return_value` on successful completion.
|
||||||
* A `Deferred` that resolves once the reader acquires the lock.
|
* A `Deferred` that resolves once the reader acquires the lock.
|
||||||
"""
|
"""
|
||||||
d, acquired_d, unblock_d = self._start_reader_or_writer(
|
d, acquired_d, unblock_d = self._start_reader_or_writer(
|
||||||
@ -106,8 +106,8 @@ class ReadWriteLockTestCase(unittest.TestCase):
|
|||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
A tuple of two `Deferred`s:
|
A tuple of two `Deferred`s:
|
||||||
* A `Deferred` that resolves with `return_value` once the writer completes
|
* A cancellable `Deferred` for the entire write operation that resolves
|
||||||
successfully.
|
with `return_value` on successful completion.
|
||||||
* A `Deferred` that resolves once the writer acquires the lock.
|
* A `Deferred` that resolves once the writer acquires the lock.
|
||||||
"""
|
"""
|
||||||
d, acquired_d, unblock_d = self._start_reader_or_writer(
|
d, acquired_d, unblock_d = self._start_reader_or_writer(
|
||||||
|
Loading…
Reference in New Issue
Block a user