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

Jump to bottom
Merged
CAM-Gerlach merged 14 commits into from
May 22, 2024
Merged

gh-70795: Rework RLock documentation #103853

CAM-Gerlach merged 14 commits into from
May 22, 2024

Conversation

@samatjain
Copy link
Contributor

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

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).

@samatjain
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).
@ghost
Copy link

ghost commented Apr 25, 2023•
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@samatjain
Copy link
ContributorAuthor

samatjain commented Apr 25, 2023

cc @CAM-Gerlach thanks for draft review!

@CAM-GerlachCAM-Gerlach self-requested a review April 25, 2023 22:34
@CAM-GerlachCAM-Gerlach added docs Documentation in the Doc dir skip news needs backport to 3.11 only security fixes labels Apr 25, 2023
@bedevere-botbedevere-bot mentioned this pull request Apr 25, 2023
Closed
gpshead
gpshead previously requested changes Apr 25, 2023
View reviewed changes
Copy link
Member

@gpsheadgpshead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some rewording suggestions.

@bedevere-bot
Copy link

bedevere-bot commented Apr 25, 2023

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.

CAM-Gerlach
CAM-Gerlach reviewed Apr 25, 2023
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

samatjainand others added 2 commits April 25, 2023 16:39
@samatjain@CAM-Gerlach
Update Doc/library/threading.rst
adc0823
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@samatjain@CAM-Gerlach
Update Doc/library/threading.rst
2f0866a
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
CAM-Gerlach
CAM-Gerlach reviewed Apr 25, 2023
View reviewed changes
CAM-Gerlach
CAM-Gerlach reviewed Apr 26, 2023
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple followup comments

samatjainand others added 2 commits April 25, 2023 18:04
@samatjain@CAM-Gerlach
Apply suggestions from code review
e9e744b
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@samatjain
move seealso section
77c1551
CAM-Gerlach
CAM-Gerlach reviewed Apr 26, 2023
View reviewed changes
@samatjain@CAM-Gerlach
Update Doc/library/threading.rst
90b3559
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
CAM-Gerlach
CAM-Gerlach approved these changes Apr 26, 2023
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@CAM-GerlachCAM-Gerlach marked this pull request as ready for review April 26, 2023 01:18
@CAM-GerlachCAM-Gerlach mentioned this pull request Apr 26, 2023
Closed
@serhiy-storchakaserhiy-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
@CAM-GerlachCAM-Gerlach dismissed gpshead’s stale reviewMay 22, 2024 19:47

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

@CAM-GerlachCAM-Gerlach merged commit 2fbea81 into python:mainMay 22, 2024
@miss-islington-app
Copy link

miss-islington-appbot commented May 22, 2024

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 22, 2024
@samatjain@AlexWaygood
@CAM-Gerlach@miss-islington
pythongh-70795: Rework RLock documentation (pythonGH-103853)
267df26
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>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 22, 2024
@samatjain@AlexWaygood
@CAM-Gerlach@miss-islington
pythongh-70795: Rework RLock documentation (pythonGH-103853)
1d9904f
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>
@bedevere-app
Copy link

bedevere-appbot commented May 22, 2024

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

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label May 22, 2024
@bedevere-app
Copy link

bedevere-appbot commented May 22, 2024

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

@bedevere-appbedevere-appbot removed the needs backport to 3.12 only security fixes label May 22, 2024
CAM-Gerlach added a commit that referenced this pull request May 22, 2024
@miss-islington@samatjain
@AlexWaygood@CAM-Gerlach
[3.12]gh-70795: Rework RLock documentation (GH-103853) (#119437)
7eb59cd
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>
gpshead pushed a commit that referenced this pull request May 22, 2024
@miss-islington@samatjain
@AlexWaygood@CAM-Gerlach
[3.13]gh-70795: Rework RLock documentation (GH-103853) (#119436)
a6ed742
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>
@JelleZijlstraJelleZijlstra mentioned this pull request May 28, 2024
Closed
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@samatjain@AlexWaygood
@CAM-Gerlach@estyxx
pythongh-70795: Rework RLock documentation (python#103853)
1fca3b4
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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gpsheadgpsheadAwaiting requested review from gpshead

@CAM-GerlachCAM-GerlachAwaiting requested review from CAM-Gerlach

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@samatjain@bedevere-bot@gpshead@CAM-Gerlach@serhiy-storchaka@AlexWaygood