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

GH-90908: Document asyncio.TaskGroup by gvanrossum · Pull Request #94359 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

GH-90908: Document asyncio.TaskGroup - #94359

Merged
ambv merged 8 commits into
python:mainfrom
gvanrossum:task-group-doc
Jun 30, 2022
ConversationCommits (8)ChecksFiles changed
Merged

GH-90908: Document asyncio.TaskGroup#94359
ambv merged 8 commits into
python:mainfrom
gvanrossum:task-group-doc

Conversation

gvanrossum commented Jun 28, 2022 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

gvanrossum added docs Documentation in the Doc dir needs backport to 3.11 only security fixes labels Jun 28, 2022
gvanrossum requested review from 1st1 and asvetlov as code owners June 28, 2022 00:01

kumaraditya303 commented Jun 28, 2022

Copy link
Copy Markdown
Contributor

It would be nice to mention this in 3.11 Whatsnews under improved modules.

gvanrossum marked this pull request as draft June 28, 2022 03:24
gvanrossum mentioned this pull request Jun 28, 2022
Closed
ambv reviewed Jun 28, 2022
View reviewed changes
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst
Comment thread Doc/library/asyncio-task.rst Outdated
gvanrossum commented Jun 28, 2022
View reviewed changes

gvanrossum left a comment

Copy link
Copy Markdown
Member 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 still have to add a section explaining how the waiting actually happens, using cancellations, and the various cases.

Comment thread Doc/library/asyncio-task.rst

vstinner commented Jun 28, 2022

Copy link
Copy Markdown
Member

That's funny. I was looking for TaskGroup in the doc, and I was surprised that it was not documented at all. When I looked for the PR which added TaskGroup, I found this PR which adds documentation, PR created 16 hours ago :-) Great!

gvanrossum commented Jun 29, 2022

Copy link
Copy Markdown
Member Author

@CAM-Gerlach This is ready for you. I'm also undrafting it.

gvanrossum marked this pull request as ready for review June 29, 2022 04:46
gvanrossum mentioned this pull request Jun 29, 2022
Closed
CAM-Gerlach reviewed Jun 30, 2022
View reviewed changes

CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

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

This looks pretty good to my relatively uneducated eye, with just a handful of minor textual/syntax suggestions. A few of the sections got a bit dense at times, but I was able to get the gist of them (despite being a rank beginner) at least after a re-read or two and without much context, and I'm not sure how to explain them more simply.

One high-level thing to consider: Perhaps consider moving the class definition closer to the top of the section, after the introduction/summary line but before the example? I'm not super solid on this, but it feels somewhat out of place at the end (especially with the example being introduced before it), and as a side effect it means that the link from What's New puts the reader at the end of the relevant section rather than the beginning. But I don't feel too strongly about it.

Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/library/asyncio-task.rst Outdated
Comment thread Doc/whatsnew/3.11.rst Outdated
gvanrossum and others added 3 commits June 30, 2022 08:48
CAM's code review
240bf48 
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Add a note recommending TaskGroup to gather
1ec56fb 
Also remove a redundant versionchanged directive.
Move 'class TaskGroup' up in its section
8126057

gvanrossum commented Jun 30, 2022

Copy link
Copy Markdown
Member Author

Maybe @ambv can approve this? We can always iterate later.

(Question: when gh-94400 is landed, we should probably mention that behavior too. Should we wait for that and then update this PR, or should we add a doc update to gh-94400?

1st1 approved these changes Jun 30, 2022
View reviewed changes

1st1 left a comment

Copy link
Copy Markdown
Member

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

Thank you for taking care of this, Guido. LGTM.

ambv merged commit b6ec6d4 into python:main Jun 30, 2022

miss-islington commented Jun 30, 2022

Copy link
Copy Markdown
Contributor

Thanks @gvanrossum for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 30, 2022
pythonGH-90908: Document asyncio.TaskGroup (pythonGH-94359)
72ed089 
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit b6ec6d4)

Co-authored-by: Guido van Rossum <guido@python.org>

bedevere-bot commented Jun 30, 2022

Copy link
Copy Markdown

GH-94456 is a backport of this pull request to the 3.11 branch.

bedevere-bot removed the needs backport to 3.11 only security fixes label Jun 30, 2022
ambv pushed a commit that referenced this pull request Jun 30, 2022
GH-90908: Document asyncio.TaskGroup (GH-94359) (GH-94456)
b3d69ff 
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit b6ec6d4)

Co-authored-by: Guido van Rossum <guido@python.org>

gvanrossum commented Jun 30, 2022

Copy link
Copy Markdown
Member Author

Thanks for the reviews and merging!

gvanrossum added a commit to gvanrossum/cpython that referenced this pull request Jun 30, 2022
pythonGH-90908: Document asyncio.TaskGroup (pythonGH-94359)
159a057 
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
gvanrossum deleted the task-group-doc branch August 7, 2022 15:52
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

ambv ambv left review comments
CAM-Gerlach CAM-Gerlach left review comments
1st1 1st1 approved these changes
asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

Back | FazBrowse Home | New Git URL