diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-10-26 02:23:08 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-26 02:23:08 (GMT) |
| commit | 866dc74afacb389077472e175d6f5cb8befc3efc (patch) | |
| tree | 7681f131f1841f7c103da88d8621a5d0e924a95d | |
| parent | cb323a86127166ee65d50be7d5d0e7848478ae70 (diff) | |
| download | cpython-866dc74afacb389077472e175d6f5cb8befc3efc.zip cpython-866dc74afacb389077472e175d6f5cb8befc3efc.tar.gz cpython-866dc74afacb389077472e175d6f5cb8befc3efc.tar.bz2 | |
gh-84747: Add `async for` comment for StreamReader (GH-98633)
(cherry picked from commit 4196ee5c8b489f457874759ee22c9237e08f85c4)
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
| -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 19210a5..bed10a4 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` |