From: Andrew Svetlov <andrew.svetlov@gmail.com>
Date: Sat, 26 Jul 2014 16:50:37 +0000 (+0300)
Subject: Document lock parameter for asyncio.Condition()
X-Git-Tag: v3.4.2rc1~181
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f200ce6333f410f32ae32a5cafbb0ac6c31999d9;p=python

Document lock parameter for asyncio.Condition()
---

diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
index a299f09085..049a0cc5c4 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()