Skip to content
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.

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

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

Merged

Conversation

EpicWink
Copy link
Contributor

@EpicWink EpicWink commented Feb 23, 2024

  • 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/

@bedevere-app bedevere-app bot mentioned this pull request Feb 23, 2024
@EpicWink EpicWink force-pushed the threading-queue-shutdown-no-raise-docs branch from 4fdeb68 to 63bdd42 Compare February 23, 2024 02:09
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

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

Doc/library/queue.rst Outdated Show resolved Hide resolved
Lib/queue.py Show resolved Hide resolved
@rhettinger rhettinger removed their request for review February 23, 2024 05:34
gvanrossum

This comment was marked as duplicate.

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Please fix the nits I called out.

@bedevere-app
Copy link

bedevere-app bot commented Feb 23, 2024

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
Copy link
Contributor Author

I have made the requested changes; please review again

Doc/library/queue.rst Outdated Show resolved Hide resolved
@gvanrossum gvanrossum enabled auto-merge (squash) February 25, 2024 16:31
@gvanrossum gvanrossum merged commit 9402ea6 into python:main Feb 25, 2024
32 of 33 checks passed
woodruffw pushed a commit to woodruffw-forks/cpython that referenced this pull request Mar 4, 2024
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants