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 | 8777d059bbb3f6bd52c8fb43ed5ddfa9951f44ef (patch) | |
| tree | de7b6cace2ce8d0b86a6987f0d1f1f5ba865015e | |
| parent | 83c8df29dd07b87031ecce8547b05f059dd091bb (diff) | |
| download | cpython-8777d059bbb3f6bd52c8fb43ed5ddfa9951f44ef.zip cpython-8777d059bbb3f6bd52c8fb43ed5ddfa9951f44ef.tar.gz cpython-8777d059bbb3f6bd52c8fb43ed5ddfa9951f44ef.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 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` |