X Tutup
The Wayback Machine - https://web.archive.org/web/20221223104117/https://github.com/python/cpython/issues/84747
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

Jump to bottom

asyncio.StreadReader async for line in reader is not documented #84747

Closed
socketpair mannequin opened this issue May 8, 2020 · 4 comments
Closed

asyncio.StreadReader async for line in reader is not documented #84747

socketpair mannequin opened this issue May 8, 2020 · 4 comments
Assignees
@slateny
Labels
3.10 3.11 3.12 docs Documentation in the Doc dir expert-asyncio

Comments

@socketpair
Copy link
Mannequin

socketpair mannequin commented May 8, 2020

BPO 40567
Nosy @asvetlov, @socketpair, @1st1

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-05-08.18:51:03.374>
labels = ['3.8', 'docs', '3.7', '3.9', 'expert-asyncio']
title = 'asyncio.StreadReader     `async for line in reader` is not documented'
updated_at = <Date 2020-05-08.18:51:13.351>
user = 'https://github.com/socketpair'

bugs.python.org fields:

activity = <Date 2020-05-08.18:51:13.351>
actor = 'socketpair'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'asyncio']
creation = <Date 2020-05-08.18:51:03.374>
creator = 'socketpair'
dependencies = []
files = []
hgrepos = []
issue_num = 40567
keywords = []
message_count = 1.0
messages = ['368453']
nosy_count = 4.0
nosy_names = ['asvetlov', 'docs@python', 'socketpair', 'yselivanov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40567'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']
@socketpair
Copy link
Mannequin Author

socketpair mannequin commented May 8, 2020

Actually it works. But it is not documented. Please ad docs.

@socketpair socketpair mannequin added 3.7 3.8 3.9 expert-asyncio docs Documentation in the Doc dir labels May 8, 2020
@socketpair socketpair mannequin assigned docspython May 8, 2020
@socketpair socketpair mannequin added the docs Documentation in the Doc dir label May 8, 2020
@socketpair socketpair mannequin assigned docspython May 8, 2020
@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@slateny
Copy link
Contributor

slateny commented Apr 23, 2022

@socketpair Could you expand a bit on what works and what needs documenting? Is it that you're looking to get a link to the async for syntax, like say here and here?

@kumaraditya303
Copy link
Contributor

kumaraditya303 commented Oct 3, 2022

Just add a line in docs that it supports the async iterable protocol with a link.

@kumaraditya303
Copy link
Contributor

kumaraditya303 commented Oct 23, 2022

@slateny Can you create a PR for this?

@bedevere-bot bedevere-bot mentioned this issue Oct 25, 2022
Merged
JelleZijlstra pushed a commit that referenced this issue Oct 26, 2022
@slateny
gh-84747: Add async for comment for StreamReader (#98633)
4196ee5
@bedevere-bot bedevere-bot mentioned this issue Oct 26, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 26, 2022
@slateny @miss-islington
pythongh-84747: Add async for comment for StreamReader (pythonGH-98633
0a690e3 
)

(cherry picked from commit 4196ee5)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@bedevere-bot bedevere-bot mentioned this issue Oct 26, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 26, 2022
@slateny @miss-islington
pythongh-84747: Add async for comment for StreamReader (pythonGH-98633
300809e 
)

(cherry picked from commit 4196ee5)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
miss-islington added a commit that referenced this issue Oct 26, 2022
@miss-islington @slateny
gh-84747: Add async for comment for StreamReader (GH-98633)
866dc74 
(cherry picked from commit 4196ee5)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
miss-islington added a commit that referenced this issue Oct 26, 2022
@miss-islington @slateny
gh-84747: Add async for comment for StreamReader (GH-98633)
8777d05 
(cherry picked from commit 4196ee5)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@slateny slateny closed this as completed Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@slateny slateny

Labels
3.10 3.11 3.12 docs Documentation in the Doc dir expert-asyncio
Projects
asyncio
Status: Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@slateny @kumaraditya303
X Tutup