diff options
| author | Stanley <46876382+slateny@users.noreply.github.com> | 2022-10-26 02:16:18 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-26 02:16:18 (GMT) |
| commit | 4196ee5c8b489f457874759ee22c9237e08f85c4 (patch) | |
| tree | b14a1f8cf2ed0e9ebb940b46229045f7664f0c9d /Doc | |
| parent | 45644905ea1352b79a0d5ab4f02e00a258206116 (diff) | |
| download | cpython-4196ee5c8b489f457874759ee22c9237e08f85c4.zip cpython-4196ee5c8b489f457874759ee22c9237e08f85c4.tar.gz cpython-4196ee5c8b489f457874759ee22c9237e08f85c4.tar.bz2 | |
gh-84747: Add `async for` comment for StreamReader (#98633)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/asyncio-stream.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index ce88d70..d87e3c0 100644 --- a/Doc/library/asyncio-stream.rst +++ b/Doc/library/asyncio-stream.rst @@ -183,7 +183,8 @@ StreamReader .. class:: StreamReader Represents a reader object that provides APIs to read data - from the IO stream. + from the IO stream. As an :term:`asynchronous iterable`, the + object supports the :keyword:`async for` statement. It is not recommended to instantiate *StreamReader* objects directly; use :func:`open_connection` and :func:`start_server` |