Clarify the docs for args in asyncio callbacks
#143873
Open
+12
−9
Conversation
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
akx
requested review from
1st1,
asvetlov,
kumaraditya303 and
willingc
as code owners
bedevere-app
bot
added
docs
| *callback*. | ||
|
|
||
| Use :func:`functools.partial` :ref:`to pass keyword arguments | ||
| You can use :func:`functools.partial` :ref:`to pass *keyword* arguments |
Member
There was a problem hiding this comment.
Please avoid such rewordings, and italics should be used for parameter names.
Contributor
Author
There was a problem hiding this comment.
I think the rewording makes it clearer (and kinder, in a sense). (What's the particular "such" here, though, so I know to avoid, well, such things in the future?)
My point for the italics was to emphasize for the reader that this is for keyword arguments, and the *args mechanism is already there for posargs.
| Raise :exc:`RuntimeError` if there is a problem setting up the handler. | ||
|
|
||
| Use :func:`functools.partial` :ref:`to pass keyword arguments | ||
| You can use :func:`functools.partial` :ref:`to pass *keyword* arguments |
| This method returns a :class:`asyncio.Future` object. | ||
|
|
||
| Use :func:`functools.partial` :ref:`to pass keyword arguments | ||
| You can use :func:`functools.partial` :ref:`to pass *keyword* arguments |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While working on asyncio-related things, my eyes somehow skipped over the "keyword arguments" part of the sentence about
functools.partial, andargswasn't at all documented foradd_signal_handler.Hence, this PR gently clarifies the documentation for
*argsin asyncio loop callbacks and unifies all of the places referring tofunctools.partialto 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/