Skip to content

gh-70795: Rework RLock documentation #103853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CAM-Gerlach merged 14 commits into from
May 22, 2024
+51 −24
Merged

gh-70795: Rework RLock documentation #103853

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
16d2a21
gh-70795: Rework RLock documentation
samatjain Apr 25, 2023
cc594c1
Double backticks for with
samatjain Apr 25, 2023
42ed620
Merge branch 'main' into gh-70795-RLock-docs
AlexWaygood Apr 25, 2023
adc0823
Update Doc/library/threading.rst
samatjain Apr 25, 2023
2f0866a
Update Doc/library/threading.rst
samatjain Apr 25, 2023
d39b41c
Apply suggestions from code review
samatjain Apr 26, 2023
6a815ec
suggestion from gpshead
samatjain Apr 26, 2023
f398ed1
seealso for with-locks
samatjain Apr 26, 2023
82c7a65
switch to bullet points
samatjain Apr 26, 2023
e35445f
re-order bullet points
samatjain Apr 26, 2023
e9e744b
Apply suggestions from code review
samatjain Apr 26, 2023
77c1551
move seealso section
samatjain Apr 26, 2023
90b3559
Update Doc/library/threading.rst
samatjain Apr 26, 2023
1c28ee7
Merge branch 'main' into gh-70795-RLock-docs
CAM-Gerlach May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
move seealso section
  • Loading branch information
@samatjain
samatjain committed Apr 26, 2023
commit 77c155143989b3dc4cb9944a8da9561d8e093f09
11 changes: 6 additions & 5 deletions Doc/library/threading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,11 +604,6 @@ and its :meth:`~Lock.release` method to unlock it.
:meth:`~RLock.acquire` and :meth:`~RLock.release`
to handle acquiring and releasing the lock for a block of code.

.. seealso::

:ref:`Using RLock as a context manager <with-locks>` is recommended
over manual :meth:`!acquire` and :meth:`release` calls whenever practical.

RLock's :meth:`~RLock.acquire`/:meth:`~RLock.release` call pairs may be nested,
unlike Lock's :meth:`~Lock.acquire`/:meth:`~Lock.release`. Only the final
:meth:`~RLock.release` (the :meth:`~Lock.release` of the outermost pair) resets
Expand Down Expand Up @@ -636,6 +631,12 @@ call release as many times the lock has been acquired can lead to deadlock.

Acquire a lock, blocking or non-blocking.

.. seealso::

:ref:`Using RLock as a context manager <with-locks>` is recommended
over manual :meth:`!acquire` and :meth:`release` calls whenever practical.
Comment thread
samatjain marked this conversation as resolved.
Outdated


When invoked with the *blocking* argument set to ``True`` (the default):

* If no thread owns the lock, acquire the lock and return immediately.
Expand Down