Skip to content

gh-132354: document return value for asyncio.Task.cancel #132374

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

Merged
merged 5 commits into from
Apr 13, 2025

Conversation

felixscherz
Copy link
Contributor

@felixscherz felixscherz commented Apr 10, 2025

Hi, this is intended to resolve #132354. I documented the return value, similar to asyncio.Future.cancel.


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

@python-cla-bot
Copy link

python-cla-bot bot commented Apr 10, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@@ -0,0 +1 @@
Document return value for :func:`asyncio.Task.cancel`.
Copy link
Contributor

@brianschubert brianschubert Apr 10, 2025

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! I removed it:)

This reverts commit e039f42.
@bedevere-app
Copy link

bedevere-app bot commented Apr 10, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@ZeroIntensity ZeroIntensity added docs Documentation in the Doc dir topic-asyncio skip news needs backport to 3.13 bugs and security fixes labels Apr 11, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Apr 11, 2025
@kumaraditya303 kumaraditya303 merged commit 64b066a into python:main Apr 13, 2025
28 checks passed
@miss-islington-app
Copy link

Thanks @felixscherz for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Apr 13, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 13, 2025
…honGH-132374)

(cherry picked from commit 64b066a)

Co-authored-by: Felix Scherz <felixwscherz@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Apr 13, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 13, 2025
kumaraditya303 pushed a commit that referenced this pull request Apr 13, 2025
…-132374) (#132465)

gh-132354: document return value for `asyncio.Task.cancel` (GH-132374)
(cherry picked from commit 64b066a)

Co-authored-by: Felix Scherz <felixwscherz@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news topic-asyncio
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

AsyncIO-Docs: Task.cancel return value not documented
4 participants