From f7a661571945b02e4c3aa77f30a86a3244cb5d2b Mon Sep 17 00:00:00 2001 From: R David Murray Date: Thu, 17 May 2012 09:13:30 -0400 Subject: [PATCH] #14823: Simplify threading.Lock.acquire argument discussion. --- Doc/library/threading.rst | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index 30f7ece6d37..43087ef153a 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -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*