gh-70795: Rework RLock documentation by samatjain · Pull Request #103853 · python/cpython · GitHub

Attempted to simultaneously reduce verbosity, while more descriptively describing behavior.

Fix links (RLock acquire/release previously linking to Lock acquire/release, seems like bad copy pasta).

Issue: RLock undocumented behavior in case of multiple acquire #70795

Attempted to simultaneously reduce verbosity, while more descriptively describing behavior. Fix links (RLock acquire/release previously linking to Lock acquire/release, seems like bad copy pasta).

All commit authors signed the Contributor License Agreement.

cc @CAM-Gerlach thanks for draft review!

some rewording suggestions.

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Thanks! Various suggested changes and fixed.

Standard reminder: You can directly apply all the suggestions you want in one go by going to Files changed -> Clicking Add to batch on each suggestion -> When done, clicking Commit

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

A couple followup comments

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

LGTM from my side; thanks @samatjain ! I'll leave it to @gpshead to re-review the content.

All comments appear to be addressed and no further were made after several months

Thanks @samatjain for the PR, and @CAM-Gerlach for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

Attempted to simultaneously reduce verbosity, while more descriptively describing behavior. Fix links (RLock acquire/release previously linking to Lock acquire/release, seems like bad copy pasta). Add a seealso for with-locks. Switch section to use bullet points. --------- (cherry picked from commit 2fbea81) Co-authored-by: uıɐɾ ʞ ʇɐɯɐs <_@skj.io> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

GH-119436 is a backport of this pull request to the 3.13 branch.

GH-119437 is a backport of this pull request to the 3.12 branch.

gh-70795: Rework RLock documentation (GH-103853) Attempted to simultaneously reduce verbosity, while more descriptively describing behavior. Fix links (RLock acquire/release previously linking to Lock acquire/release, seems like bad copy pasta). Add a seealso for with-locks. Switch section to use bullet points. --------- (cherry picked from commit 2fbea81) Co-authored-by: uıɐɾ ʞ ʇɐɯɐs <_@skj.io> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Attempted to simultaneously reduce verbosity, while more descriptively describing behavior. Fix links (RLock acquire/release previously linking to Lock acquire/release, seems like bad copy pasta). Add a seealso for with-locks. Switch section to use bullet points. --------- Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

pythongh-70795 : Rework RLock documentation

16d2a21

Attempted to simultaneously reduce verbosity, while more descriptively describing behavior. Fix links (RLock acquire/release previously linking to Lock acquire/release, seems like bad copy pasta).

Double backticks for with

cc594c1

CAM-Gerlach self-requested a review April 25, 2023 22:34

CAM-Gerlach added docs Documentation in the Doc dir skip news needs backport to 3.11 only security fixes labels Apr 25, 2023

Merge branch 'main' into pythongh-70795 -RLock-docs

42ed620

bedevere-bot mentioned this pull request Apr 25, 2023

RLock undocumented behavior in case of multiple acquire #70795

Closed

gpshead previously requested changes Apr 25, 2023

View reviewed changes

Comment thread Doc/library/threading.rst Outdated

Comment thread Doc/library/threading.rst Outdated

Comment thread Doc/library/threading.rst Outdated

Comment thread Doc/library/threading.rst Outdated

Comment thread Doc/library/threading.rst Outdated

bedevere-bot added the awaiting changes label Apr 25, 2023

CAM-Gerlach reviewed Apr 25, 2023

View reviewed changes

samatjain and others added 2 commits April 25, 2023 16:39

Update Doc/library/threading.rst

adc0823

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Update Doc/library/threading.rst

2f0866a

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

CAM-Gerlach reviewed Apr 25, 2023

View reviewed changes

Comment thread Doc/library/threading.rst Outdated

samatjain and others added 4 commits April 25, 2023 17:02

Apply suggestions from code review

d39b41c

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

suggestion from gpshead

6a815ec

seealso for with-locks

f398ed1

switch to bullet points

82c7a65

samatjain requested review from CAM-Gerlach and gpshead April 26, 2023 00:23

re-order bullet points

e35445f

CAM-Gerlach reviewed Apr 26, 2023

View reviewed changes

Comment thread Doc/library/threading.rst Outdated

Comment thread Doc/library/threading.rst Outdated

samatjain and others added 2 commits April 25, 2023 18:04

Apply suggestions from code review

e9e744b

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

move seealso section

77c1551

CAM-Gerlach reviewed Apr 26, 2023

View reviewed changes

Comment thread Doc/library/threading.rst Outdated

Update Doc/library/threading.rst

90b3559

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

CAM-Gerlach approved these changes Apr 26, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Apr 26, 2023

CAM-Gerlach marked this pull request as ready for review April 26, 2023 01:18

CAM-Gerlach mentioned this pull request Apr 26, 2023

Consider switching to native GitHub automerge python/core-workflow#498

Closed

samatjain requested a review from CAM-Gerlach May 10, 2023 05:58

serhiy-storchaka added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes and removed needs backport to 3.11 only security fixes labels May 9, 2024

Merge branch 'main' into pythongh-70795 -RLock-docs

1c28ee7

CAM-Gerlach merged commit 2fbea81 into python:main May 22, 2024

bedevere-app Bot removed the awaiting merge label May 22, 2024

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label May 22, 2024

bedevere-app Bot removed the needs backport to 3.12 only security fixes label May 22, 2024

JelleZijlstra mentioned this pull request May 28, 2024

backport a9a74da 3.13 #119642

Closed

gh-70795: Rework RLock documentation by samatjain · Pull Request #103853 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-70795: Rework RLock documentation - #103853

gh-70795: Rework RLock documentation#103853CAM-Gerlach merged 14 commits intopython:mainpython/cpython:mainfrom samatjain:gh-70795-RLock-docssamatjain/cpython:gh-70795-RLock-docsCopy head branch name to clipboard

Conversation

samatjain commented Apr 25, 2023 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Apr 25, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samatjain commented Apr 25, 2023

Uh oh!

gpshead left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Apr 25, 2023

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington-app Bot commented May 22, 2024

Uh oh!

bedevere-app Bot commented May 22, 2024

Uh oh!

bedevere-app Bot commented May 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

gh-70795: Rework RLock documentation#103853
CAM-Gerlach merged 14 commits into
python:mainfrom
samatjain:gh-70795-RLock-docs

samatjain commented Apr 25, 2023 •
edited by bedevere-bot
Loading

ghost commented Apr 25, 2023 •
edited by ghost
Loading