diff options
| author | Andrew Svetlov <andrew.svetlov@gmail.com> | 2014-07-26 16:50:37 (GMT) |
|---|---|---|
| committer | Andrew Svetlov <andrew.svetlov@gmail.com> | 2014-07-26 16:50:37 (GMT) |
| commit | f200ce6333f410f32ae32a5cafbb0ac6c31999d9 (patch) | |
| tree | fdd040ab22aa1f2e05e48cf875bd0b613e6523a5 | |
| parent | d2e9fdfbdef17b1159c14569260ac1dc18dfebff (diff) | |
| download | cpython-f200ce6333f410f32ae32a5cafbb0ac6c31999d9.zip cpython-f200ce6333f410f32ae32a5cafbb0ac6c31999d9.tar.gz cpython-f200ce6333f410f32ae32a5cafbb0ac6c31999d9.tar.bz2 | |
Document lock parameter for asyncio.Condition()
| -rw-r--r-- | Doc/library/asyncio-sync.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst index a299f09..049a0cc 100644 --- a/Doc/library/asyncio-sync.rst +++ b/Doc/library/asyncio-sync.rst @@ -130,7 +130,7 @@ Event Condition ^^^^^^^^^ -.. class:: Condition(\*, loop=None) +.. class:: Condition(lock=None, \*, loop=None) A Condition implementation, asynchronous equivalent to :class:`threading.Condition`. @@ -139,7 +139,9 @@ Condition allows one or more coroutines to wait until they are notified by another coroutine. - A new :class:`Lock` object is created and used as the underlying lock. + If the *lock* argument is given and not ``None``, it must be a :class:`Lock` + object, and it is used as the underlying lock. Otherwise, + a new :class:`Lock` object is created and used as the underlying lock. .. method:: acquire() |