FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Clarify the docs for `args` in asyncio callbacks by akx · Pull Request #143873 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

Clarify the docs for args in asyncio callbacks - #143873

Merged
kumaraditya303 merged 4 commits into
python:mainfrom
akx:add-signal-handler-docs
Feb 10, 2026
ConversationCommits (4)ChecksFiles changed
Merged

Clarify the docs for args in asyncio callbacks#143873
kumaraditya303 merged 4 commits into
python:mainfrom
akx:add-signal-handler-docs

Conversation

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

Copy link
Copy Markdown
Contributor

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 Bot added docs Documentation in the Doc dir skip news awaiting review labels Jan 15, 2026
github-project-automation Bot moved this to Todo in Docs PRs Jan 15, 2026
StanFromIreland reviewed Jan 15, 2026
View reviewed changes
Comment thread Doc/library/asyncio-eventloop.rst Outdated
Comment thread Doc/library/asyncio-eventloop.rst Outdated
Comment thread Doc/library/asyncio-eventloop.rst Outdated
picnixz reviewed Jan 19, 2026
View reviewed changes
Comment thread 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.

picnixz Jan 19, 2026 •
edited
Loading

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

StanFromIreland commented Jan 19, 2026

Copy link
Copy Markdown
Member

Updating branch to fix the CI.

kumaraditya303 requested changes Feb 6, 2026
View reviewed changes

kumaraditya303 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

awaiting changes for Bénédikt's review

bedevere-app Bot commented Feb 6, 2026

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.

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

miss-islington-app Bot commented Feb 10, 2026

Copy link
Copy Markdown

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
Clarify the docs for args in asyncio callbacks (pythonGH-143873)
1dd57bc 
(cherry picked from commit 40a82ab)

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
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 Bot commented Feb 10, 2026

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Feb 10, 2026

bedevere-app Bot commented Feb 10, 2026

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Feb 10, 2026
kumaraditya303 added a commit that referenced this pull request Feb 10, 2026
[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
[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>
thunder-coding pushed a commit to thunder-coding/cpython that referenced this pull request Feb 15, 2026
Clarify the docs for args in asyncio callbacks (python#143873)
8407c98 
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
brijkapadia pushed a commit to brijkapadia/cpython that referenced this pull request Feb 28, 2026
Clarify the docs for args in asyncio callbacks (python#143873)
f074be1 
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
ljfp pushed a commit to ljfp/cpython that referenced this pull request Apr 25, 2026
Clarify the docs for args in asyncio callbacks (python#143873)
c4663b3 
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

picnixz picnixz left review comments
kumaraditya303 kumaraditya303 approved these changes
1st1 Awaiting requested review from 1st1 1st1 is a code owner
asvetlov Awaiting requested review from asvetlov asvetlov is a code owner
willingc Awaiting requested review from willingc willingc is a code owner
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

Back | FazBrowse Home | New Git URL