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
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
Apply suggestions from code review 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
  • Loading branch information
@samatjain @CAM-Gerlach
samatjain and CAM-Gerlach authored Apr 26, 2023
commit e9e744b619467cf728fa05b0386a8934dc28495e
14 changes: 10 additions & 4 deletions Doc/library/threading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -595,13 +595,19 @@ locks. In the locked state, some thread owns the lock; in the unlocked state,
no thread owns it.

Threads call a lock's :meth:`~RLock.acquire` method to lock it,
and its :meth:`~Lock.release` method to unlock it. Reentrant locks
support the :ref:`context management protocol <with-locks>` so :keyword:`with` can be used
to acquire and release the lock automatically in a block of code.
and its :meth:`~Lock.release` method to unlock it.

.. note::

Reentrant locks support the :ref:`context management protocol <with-locks>`,
so it is recommended to use :keyword:`with` instead of manually calling
:meth:`~RLock.acquire` and :meth:`~RLock.release`
to handle acquiring and releasing the lock for a block of code.

.. seealso::

:ref:`with-locks`.
: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
Expand Down