languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-14 16:37:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

gh-96448: fix documentation for _thread.lock.acquire (#96449)

Browse source 
* fix documentation for _thread.lock.acquire

* update formatting of _thread.lock.acquire() doc
This commit is contained in:
Daniel Giger 2022-10-04 18:18:04 -04:00 committed by GitHub
parent 87679a6e60
commit 7acb93f0d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/_thread.rst
View 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.