◐ Shell
reader mode source ↗
Skip to content

gh-96471: Correct docs for queue shutdown raises#115838

Merged
gvanrossum merged 5 commits into
python:mainfrom
EpicWink:threading-queue-shutdown-no-raise-docs
Feb 25, 2024
Merged

gh-96471: Correct docs for queue shutdown raises#115838
gvanrossum merged 5 commits into
python:mainfrom
EpicWink:threading-queue-shutdown-no-raise-docs

Conversation

@EpicWink

@EpicWink EpicWink commented Feb 23, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • Remove "raises ShutDown" from Queue.join() and Queue.task_done() documentation (including doc-string)
  • Clarify Queue.shutdown() behaviour (it doesn't raise itself, but causes other methods to raise)
  • Add that Queue.task_done() is called by Queue.shutdown(immediate=True) for each item in the queue

Caused by: #104750

📚 Documentation preview 📚: https://cpython-previews--115838.org.readthedocs.build/

@EpicWink EpicWink requested a review from rhettinger as a code owner February 23, 2024 02:08
@bedevere-app bedevere-app Bot mentioned this pull request Feb 23, 2024
Open
@EpicWink EpicWink force-pushed the threading-queue-shutdown-no-raise-docs branch from 4fdeb68 to 63bdd42 Compare February 23, 2024 02:09
@EpicWink EpicWink force-pushed the threading-queue-shutdown-no-raise-docs branch from 63bdd42 to c1bcb5d Compare February 23, 2024 02:10
@EpicWink EpicWink mentioned this pull request Feb 23, 2024
Merged
gvanrossum
gvanrossum reviewed Feb 23, 2024
View reviewed changes

@gvanrossum gvanrossum left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Thanks! Two nits and then I'll merge this. (I feel bad that I didn't catch this in review.)

@rhettinger rhettinger removed their request for review February 23, 2024 05:34
gvanrossum

This comment was marked as duplicate.

Sign in to view

gvanrossum
gvanrossum requested changes Feb 23, 2024
View reviewed changes

@gvanrossum gvanrossum left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Please fix the nits I called out.

@bedevere-app bedevere-app Bot added and removed awaiting review labels Feb 23, 2024
@bedevere-app

bedevere-app Bot commented Feb 23, 2024

Copy link
Copy Markdown

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.

@EpicWink

EpicWink commented Feb 25, 2024

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again

@EpicWink EpicWink mentioned this pull request Feb 25, 2024
Merged
@gvanrossum gvanrossum enabled auto-merge (squash) February 25, 2024 16:31
@gvanrossum gvanrossum merged commit 9402ea6 into python:main Feb 25, 2024
woodruffw pushed a commit to woodruffw-forks/cpython that referenced this pull request Mar 4, 2024
@EpicWink @woodruffw
pythongh-96471: Correct docs for queue shutdown (python#115838)
12a5bb8
@EpicWink EpicWink deleted the threading-queue-shutdown-no-raise-docs branch April 11, 2024 01:10
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
@EpicWink @diegorusso
pythongh-96471: Correct docs for queue shutdown (python#115838)
c291991
LukasWoodtli pushed a commit to LukasWoodtli/cpython that referenced this pull request Jan 22, 2025
@EpicWink @LukasWoodtli
pythongh-96471: Correct docs for queue shutdown (python#115838)
12b70b5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gvanrossum gvanrossum gvanrossum approved these changes

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@EpicWink @gvanrossum