From: R David Murray Date: Thu, 17 May 2012 13:15:02 +0000 (-0400) Subject: #14823: Simplify threading.Lock.acquire argument discussion. X-Git-Tag: v2.7.4rc1~814 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1bddab7f0c01c70d2102d93c14d3164ed5ce1f10;p=python #14823: Simplify threading.Lock.acquire argument discussion. --- diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index 89434b6efd..44e4d6dd05 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -401,15 +401,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``. .. method:: Lock.release()