Skip to content

Clarify the docs for args in asyncio callbacks #143873

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
kumaraditya303 merged 4 commits into from
Feb 10, 2026
Merged

Clarify the docs for args in asyncio callbacks #143873

kumaraditya303 merged 4 commits into from
Feb 10, 2026

Conversation

@akx
Copy link
Contributor

@akx akx commented Jan 15, 2026 •
edited by github-actions bot
Loading

While working on asyncio-related things, my eyes somehow skipped over the "keyword arguments" part of the sentence about functools.partial, and args wasn't at all documented for add_signal_handler.

Hence, this PR gently clarifies the documentation for *args in asyncio loop callbacks and unifies all of the places referring to functools.partial to have similar verbiage.

I think this is a trivial enough documentation improvement that it doesn't require an issue, but let me know if not so.

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

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Jan 15, 2026
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jan 15, 2026
StanFromIreland
StanFromIreland reviewed Jan 15, 2026
View reviewed changes
picnixz
picnixz reviewed Jan 19, 2026
View reviewed changes
Doc/library/asyncio-eventloop.rst Outdated

Arrange for *func* to be called in the specified executor.
Arrange for *func* to be called in the specified executor
with *args* being passed as positional arguments.
Copy link
Member

@picnixz picnixz Jan 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Can we use the same formulation as elsewhere (that is use either "passing...." or "with args ...")

@StanFromIreland
Copy link
Member

StanFromIreland commented Jan 19, 2026

Updating branch to fix the CI.

kumaraditya303
kumaraditya303 requested changes Feb 6, 2026
View reviewed changes
Copy link
Contributor

@kumaraditya303 kumaraditya303 left a comment

Choose a reason for hiding this comment

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

awaiting changes for Bénédikt's review

@bedevere-app
Copy link

bedevere-app bot commented Feb 6, 2026

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.

@kumaraditya303 kumaraditya303 added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Feb 10, 2026
@kumaraditya303 kumaraditya303 enabled auto-merge (squash) February 10, 2026 13:05
@kumaraditya303 kumaraditya303 merged commit 40a82ab into python:main Feb 10, 2026
35 of 37 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Feb 10, 2026
@miss-islington-app
Copy link

miss-islington-app bot commented Feb 10, 2026

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 10, 2026
@akx @kumaraditya303 @miss-islington
Clarify the docs for args in asyncio callbacks (pythonGH-143873)
1dd57bc 
(cherry picked from commit 40a82abe9335e78e34ca564243499490e50b8888)

Co-authored-by: Aarni Koskela <akx@iki.fi>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 10, 2026
@akx @kumaraditya303 @miss-islington
Clarify the docs for args in asyncio callbacks (pythonGH-143873)
7d803c8 
(cherry picked from commit 40a82ab)

Co-authored-by: Aarni Koskela <akx@iki.fi>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
@bedevere-app
Copy link

bedevere-app bot commented Feb 10, 2026

GH-144663 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Feb 10, 2026
@bedevere-app
Copy link

bedevere-app bot commented Feb 10, 2026

GH-144664 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 Feb 10, 2026
kumaraditya303 added a commit that referenced this pull request Feb 10, 2026
@miss-islington @akx @kumaraditya303
[3.13] Clarify the docs for args in asyncio callbacks (GH-143873) (#…
c49835a 
…144664)

Clarify the docs for `args` in asyncio callbacks (GH-143873)
(cherry picked from commit 40a82ab)

Co-authored-by: Aarni Koskela <akx@iki.fi>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
kumaraditya303 added a commit that referenced this pull request Feb 10, 2026
@miss-islington @akx @kumaraditya303
[3.14] Clarify the docs for args in asyncio callbacks (GH-143873) (#…
bcbeff5 
…144663)

Clarify the docs for `args` in asyncio callbacks (GH-143873)
(cherry picked from commit 40a82ab)

Co-authored-by: Aarni Koskela <akx@iki.fi>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz left review comments

@kumaraditya303 kumaraditya303 kumaraditya303 approved these changes

@1st1 1st1 Awaiting requested review from 1st1 1st1 is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

@willingc willingc Awaiting requested review from willingc willingc is a code owner

@StanFromIreland StanFromIreland Awaiting requested review from StanFromIreland

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@akx @StanFromIreland @picnixz @kumaraditya303