Skip to content

/ cpython

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add asyncio source code links #16640

Merged
merged 7 commits into from Oct 10, 2019
Merged

Docs: Add asyncio source code links #16640

merged 7 commits into from Oct 10, 2019

Conversation

@aeros
Copy link
Member

aeros commented Oct 8, 2019

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.
@aeros
Docs: Add asyncio source code links
Loading status checks…
c644efc
@aeros aeros requested review from 1st1, asvetlov and rhettinger as code owners Oct 8, 2019
@aeros
aeros reviewed Oct 8, 2019
View changes
Doc/library/asyncio-eventloop.rst Show resolved Hide resolved
@aeros
aeros reviewed Oct 8, 2019
View changes
Doc/library/asyncio-task.rst
: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,
Comment on lines +21 to +23

This comment has been minimized.

Sign in to view
Copy link
@aeros

aeros Oct 8, 2019

Author Member

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

This comment has been minimized.

Sign in to view
Copy link
Member Author

aeros commented Oct 8, 2019

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

/cc @1st1
@aeros
aeros reviewed Oct 8, 2019
View changes
Doc/library/asyncio-eventloop.rst Outdated Show resolved Hide resolved
@1st1
1st1 reviewed Oct 8, 2019
View changes
Doc/library/asyncio-eventloop.rst Outdated Show resolved Hide resolved
@aeros
Revert asyncio-event-loop ref
Loading status checks…
19f495c
@aeros aeros requested a review from 1st1 Oct 8, 2019
@1st1
1st1 reviewed Oct 8, 2019
View changes
Doc/library/asyncio-task.rst Outdated Show resolved Hide resolved
@1st1
1st1 reviewed Oct 8, 2019
View changes
Doc/library/asyncio-task.rst Outdated Show resolved Hide resolved
@1st1
1st1 reviewed Oct 8, 2019
View changes
Doc/library/asyncio.rst Outdated Show resolved Hide resolved
aeros added 4 commits Oct 10, 2019
@aeros
Move Lib/asyncio source link
8465b7e
@aeros
Remove tasks and base_tasks source links
91664af
@aeros
Merge branch 'docs-asycnio-source-code' of https://github.com/aeros/c…
8b34489 
…python into docs-asycnio-source-code
@aeros
Move asyncio.run source link
Loading status checks…
e5dcdb5
@aeros aeros requested a review from 1st1 Oct 10, 2019
@1st1
1st1 reviewed Oct 10, 2019
View changes
Doc/library/asyncio-task.rst Show resolved Hide resolved
@aeros
Fix indentation for asyncio.run note
Loading status checks…
eaddd03
@aeros
aeros reviewed Oct 10, 2019
View changes
Doc/library/asyncio.rst Show resolved Hide resolved
@1st1

This comment has been minimized.

Sign in to view
Copy link
Member

1st1 commented Oct 10, 2019

Alright, let's merge this! Thank you, Kyle!
@1st1
1st1 approved these changes Oct 10, 2019
View changes
@1st1 1st1 merged commit f900064 into python:master Oct 10, 2019
4 checks passed
4 checks passed
Azure Pipelines PR #20191010.63 succeeded
Details
bedevere/issue-number Issue report skipped
bedevere/news "skip news" label found
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@miss-islington

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Oct 10, 2019

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 added a commit to miss-islington/cpython that referenced this pull request Oct 10, 2019
@aeros @miss-islington
docs: Add asyncio source code links (pythonGH-16640)
852d846 
(cherry picked from commit f900064)

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

This comment has been minimized.

Sign in to view
Copy link

bedevere-bot commented Oct 10, 2019

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

This comment has been minimized.

Sign in to view
Copy link

miss-islington commented Oct 10, 2019

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 f900064 3.7
@1st1

This comment has been minimized.

Sign in to view
Copy link
Member

1st1 commented Oct 10, 2019

@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
@miss-islington @aeros
docs: Add asyncio source code links (GH-16640)
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
6bfeb81 
(cherry picked from commit f900064)

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

This comment has been minimized.

Sign in to view
Copy link
Member Author

aeros commented Oct 10, 2019 •
edited

@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

This comment has been minimized.

Sign in to view
Copy link
Member Author

aeros commented Oct 10, 2019

Also, thanks for the great feedback and discussions as usual Yury. (:
jacobneiltaylor added a commit to jacobneiltaylor/cpython that referenced this pull request Dec 5, 2019
@aeros @jacobneiltaylor
docs: Add asyncio source code links (pythonGH-16640)
8c0a651
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@1st1 1st1

@asvetlov asvetlov

@rhettinger rhettinger

Assignees

@1st1 1st1

Labels
CLA signed expert-asyncio skip issue skip news type-documentation
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
@aeros @1st1 @miss-islington @bedevere-bot @the-knights-who-say-ni
You can’t perform that action at this time.