Skip to content
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

gh-124668: Update asyncio doc landing page with examples #125594

Closed
wants to merge 2 commits into from

Conversation

xuantengh
Copy link
Contributor

@xuantengh xuantengh commented Oct 16, 2024

This PR aims to present asyncio common usages in the document landing page.


📚 Documentation preview 📚: https://cpython-previews--125594.org.readthedocs.build/

Copy link

cpython-cla-bot bot commented Oct 16, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@xuantengh
Copy link
Contributor Author


import asyncio

loop = asyncio.get_event_loop()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1 on covering low level API and especially the fragile get_event_loop() on the landing page.

Also -1 on using create_task -- we have asyncio.TaskGroup for this.

Copy link
Member

@1st1 1st1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I honestly don't think this makes things clearer. It unloads too much content on the front page, making the page intimidating and also making the TOC links on top harder to notice. So I'm -1 on this.

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @xuantengh, Welcome to CPython!

While I appreciate your interest in working on the issue and opening a PR, I would prefer that we keep the asyncio main page straightforward. I understand that examples can be helpful; however, I think those examples should be put within the Guides and Tutorials section.

I left some general feedback on the original issue: #124668 (comment)

This also includes a screenshot of the current doc structure for asyncio.

I'm recommending that we close this PR. If you wish to add examples to another page, please do so in a new PR. Thanks! ☀️

@xuantengh
Copy link
Contributor Author

Sure, I'll add examples in corresponding pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants