]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-96448: fix documentation for _thread.lock.acquire (#96449)
authorDaniel Giger <danielg3432@gmail.com>
Tue, 4 Oct 2022 22:18:04 +0000 (18:18 -0400)
committerGitHub <noreply@github.com>
Tue, 4 Oct 2022 22:18:04 +0000 (15:18 -0700)
* fix documentation for _thread.lock.acquire

* update formatting of _thread.lock.acquire() doc

Doc/library/_thread.rst

index d61ce9039349dba0d3478a3121d4b7d3f461ddae..9df9e7914e093b1b42dbdd745b53c754a5a696f6 100644 (file)
@@ -157,21 +157,21 @@ This module defines the following constants and functions:
 Lock objects have the following methods:
 
 
-.. method:: lock.acquire(waitflag=1, timeout=-1)
+.. method:: lock.acquire(blocking=True, timeout=-1)
 
    Without any optional argument, this method acquires the lock unconditionally, if
    necessary waiting until it is released by another thread (only one thread at a
    time can acquire a lock --- that's their reason for existence).
 
-   If the integer *waitflag* argument is present, the action depends on its
-   value: if it is zero, the lock is only acquired if it can be acquired
-   immediately without waiting, while if it is nonzero, the lock is acquired
+   If the *blocking* argument is present, the action depends on its
+   value: if it is False, the lock is only acquired if it can be acquired
+   immediately without waiting, while if it is True, the lock is acquired
    unconditionally as above.
 
    If the floating-point *timeout* argument is present and positive, it
    specifies the maximum wait time in seconds before returning.  A negative
    *timeout* argument specifies an unbounded wait.  You cannot specify
-   a *timeout* if *waitflag* is zero.
+   a *timeout* if *blocking* is False.
 
    The return value is ``True`` if the lock is acquired successfully,
    ``False`` if not.