Docs: Add asyncio source code links #16640
Conversation
| :term:`Coroutines <coroutine>` declared with the async/await syntax is the | ||
| preferred way of writing asyncio applications. For example, the following | ||
| snippet of code (requires Python 3.7+) prints "hello", waits 1 second, |
There was a problem hiding this comment.
I had to adjust the word wrapping here after adding the Sphinx role and grammar fix.
|
Yury had approved of the idea to add source code links to the asyncio docs. /cc @1st1 |
|
Alright, let's merge this! Thank you, Kyle! |
(cherry picked from commit f900064) Co-authored-by: Kyle Stanley <aeros167@gmail.com>
|
GH-16711 is a backport of this pull request to the 3.8 branch. |
|
Sorry, @aeros and @1st1, I could not cleanly backport this to |
|
@aeros You'll need to manually create a PR towards 3.7 (although I suggest not too, as the site will soon switch to rendering 3.8 branch) |
(cherry picked from commit f900064) Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Oh okay, we can just skip the 3.7 backport then. I'm mostly concerned with the source links being present in the latest stable version of the docs and for 3.9. |
|
Also, thanks for the great feedback and discussions as usual Yury. (: |
Many of the other stdlib modules link to the source code in the documentation pages. Asyncio currently does not.
This PR adds source code links to the documentation pages for asyncio. It also fixes the location of a reference point in
asyncio-eventloop.rst(which fixes a link inasyncio.rst), adds a Sphinx term (link to glossary) for "coroutine" inasyncio-task.rst, and fixes a minor grammar typo.