gh-138072: Small clarifications and phrasing improvements to asyncio HOWTO #138073
+24
−11
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
anordin95
requested review from
1st1,
asvetlov,
kumaraditya303 and
willingc
as code owners
bedevere-app
bot
added
awaiting review
docs
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
| :mod:`!asyncio` automatically associates tasks with the event loop for you. | ||
| Typically there's only one event loop, so that's quite straightforward. | ||
| It's uncommon, but some applications use multithreading and :mod:`!asyncio` | ||
| together, where there's one event loop per thread, stored in thread-local |
There was a problem hiding this comment.
"stored in thread-local" is unnecesary implemenetation detail for the reader, just per thread seems sufficient.
There was a problem hiding this comment.
See discussion here: #138073 (comment)
There was a problem hiding this comment.
I'd also be OK with just "per thread". But, I don't totally understand the rationale to clarify thread-locality here -- what was wrong with the original wording?
| @@ -251,6 +253,10 @@ different ways:: | |||
| In a crucial way, the behavior of ``await`` depends on the type of object | |||
| being awaited. | |||
|
|
|||
| ^^^^^^^^^^ | |||
| await task | |||
There was a problem hiding this comment.
Suggested change
| await task | |
| Awaiting Tasks |
There was a problem hiding this comment.
I prefer the original for two reasons.
The titles come from the references made in the broader await section intro.
And they fit more naturally in the broader table of contents:
| @@ -282,6 +288,10 @@ This is a basic, yet reliable mental model. | |||
| In practice, the control handoffs are slightly more complex, but not by much. | |||
| In part 2, we'll walk through the details that make this possible. | |||
|
|
|||
| ^^^^^^^^^^^^^^^ | |||
| await coroutine | |||
There was a problem hiding this comment.
Suggested change
| await coroutine | |
| Awaiting Coroutines |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
📚 Documentation preview 📚: https://cpython-previews--138073.org.readthedocs.build/