]> granicus.if.org Git - python/commitdiff
#14823: Simplify threading.Lock.acquire argument discussion.
authorR David Murray <rdmurray@bitdance.com>
Thu, 17 May 2012 13:13:30 +0000 (09:13 -0400)
committerR David Murray <rdmurray@bitdance.com>
Thu, 17 May 2012 13:13:30 +0000 (09:13 -0400)
Doc/library/threading.rst

index 30f7ece6d3734ea7907d3badeaca1bd0f52648b5..43087ef153ad16af6393db043df125cc256f8535 100644 (file)
@@ -403,15 +403,12 @@ All methods are executed atomically.
 
    Acquire a lock, blocking or non-blocking.
 
-   When invoked without arguments, block until the lock is unlocked, then set it to
-   locked, and return true.
+   When invoked with the *blocking* argument set to ``True`` (the default),
+   block until the lock is unlocked, then set it to locked and return ``True``.
 
-   When invoked with the *blocking* argument set to true, do the same thing as when
-   called without arguments, and return true.
-
-   When invoked with the *blocking* argument set to false, do not block.  If a call
-   without an argument would block, return false immediately; otherwise, do the
-   same thing as when called without arguments, and return true.
+   When invoked with the *blocking* argument set to ``False``, do not block.
+   If a call with *blocking* set to ``True`` would block, return ``False``
+   immediately; otherwise, set the lock to locked and return ``True``.
 
    When invoked with the floating-point *timeout* argument set to a positive
    value, block for at most the number of seconds specified by *timeout*