Document lock parameter for asyncio.Condition()

This commit is contained in:
Andrew Svetlov 2014-07-26 19:53:38 +03:00
commit 83e6675c0d
1 changed files with 4 additions and 2 deletions

View File

@ -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()