Skip to content

Commit

Permalink
[3.10] gh-96448: fix documentation for _thread.lock.acquire (GH-96449) (
Browse files Browse the repository at this point in the history
#97852)

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

* fix documentation for _thread.lock.acquire

* update formatting of _thread.lock.acquire() doc
(cherry picked from commit 7acb93f)

Co-authored-by: Daniel Giger <danielg3432@gmail.com>

Co-authored-by: Daniel Giger <danielg3432@gmail.com>
  • Loading branch information
miss-islington and dgiger42 authored Oct 4, 2022
1 parent 989bdbc commit f9b49b6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Doc/library/_thread.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,21 +155,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.
Expand Down

0 comments on commit f9b49b6

Please sign in to comment.