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

Docs: Add asyncio source code links by aeros · Pull Request #16640 · python/cpython · GitHub

/ cpython Public

Docs: Add asyncio source code links - #16640

Merged
1st1 merged 7 commits into
python:masterfrom
aeros:docs-asycnio-source-code
Oct 10, 2019
ConversationCommits (7)ChecksFiles changed
Merged

Docs: Add asyncio source code links#16640
1st1 merged 7 commits into
python:masterfrom
aeros:docs-asycnio-source-code

Conversation

aeros commented Oct 8, 2019

Copy link
Copy Markdown
Contributor

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 in asyncio.rst), adds a Sphinx term (link to glossary) for "coroutine" in asyncio-task.rst, and fixes a minor grammar typo.

bedevere-bot added the docs Documentation in the Doc dir label Oct 8, 2019
aeros commented Oct 8, 2019
View reviewed changes
Comment thread Doc/library/asyncio-eventloop.rst
aeros commented Oct 8, 2019
View reviewed changes
Comment thread Doc/library/asyncio-task.rst
Comment on lines +21 to +23
: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,

aeros Oct 8, 2019

Copy link
Copy Markdown
Contributor Author

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

I had to adjust the word wrapping here after adding the Sphinx role and grammar fix.

aeros commented Oct 8, 2019

Copy link
Copy Markdown
Contributor Author

Yury had approved of the idea to add source code links to the asyncio docs.

/cc @1st1

aeros commented Oct 8, 2019
View reviewed changes
Comment thread Doc/library/asyncio-eventloop.rst
1st1 reviewed Oct 8, 2019
View reviewed changes
Comment thread Doc/library/asyncio-eventloop.rst Outdated
aeros requested a review from 1st1 October 8, 2019 18:48
1st1 reviewed Oct 8, 2019
View reviewed changes
Comment thread Doc/library/asyncio-task.rst Outdated
1st1 reviewed Oct 8, 2019
View reviewed changes
Comment thread Doc/library/asyncio-task.rst Outdated
1st1 reviewed Oct 8, 2019
View reviewed changes
Comment thread Doc/library/asyncio.rst Outdated
aeros requested a review from 1st1 October 10, 2019 21:47
1st1 reviewed Oct 10, 2019
View reviewed changes
Comment thread Doc/library/asyncio-task.rst
aeros commented Oct 10, 2019
View reviewed changes
Comment thread Doc/library/asyncio.rst

1st1 commented Oct 10, 2019

Copy link
Copy Markdown
Member

Alright, let's merge this! Thank you, Kyle!

1st1 merged commit f900064 into python:master Oct 10, 2019

miss-islington commented Oct 10, 2019

Copy link
Copy Markdown
Contributor

Thanks @aeros for the PR, and @1st1 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 10, 2019
docs: Add asyncio source code links (pythonGH-16640)
852d846 
(cherry picked from commit f900064)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>

bedevere-bot commented Oct 10, 2019

Copy link
Copy Markdown

GH-16711 is a backport of this pull request to the 3.8 branch.

miss-islington commented Oct 10, 2019

Copy link
Copy Markdown
Contributor

Sorry, @aeros and @1st1, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker f900064ac4b35226caad7502abc8a7e64f1c0e9d 3.7

1st1 commented Oct 10, 2019

Copy link
Copy Markdown
Member

@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)

miss-islington added a commit that referenced this pull request Oct 10, 2019
docs: Add asyncio source code links (GH-16640)
6bfeb81 
(cherry picked from commit f900064)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>

aeros commented Oct 10, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@1st1

although I suggest not too, as the site will soon switch to rendering 3.8 branch

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.

aeros commented Oct 10, 2019

Copy link
Copy Markdown
Contributor Author

Also, thanks for the great feedback and discussions as usual Yury. (:

jacobneiltaylor pushed a commit to jacobneiltaylor/cpython that referenced this pull request Dec 5, 2019
docs: Add asyncio source code links (pythonGH-16640)
8c0a651
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

1st1 1st1 approved these changes
asvetlov Awaiting requested review from asvetlov
rhettinger Awaiting requested review from rhettinger

Assignees

1st1

Labels

docs Documentation in the Doc dir skip issue skip news topic-asyncio

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL