From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Wed, 26 Oct 2022 02:23:08 +0000 (-0700) Subject: gh-84747: Add `async for` comment for StreamReader (GH-98633) X-Git-Tag: v3.10.9~122 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=866dc74afacb389077472e175d6f5cb8befc3efc;p=thirdparty%2FPython%2Fcpython.git 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> --- diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index 19210a556057..bed10a40fb7e 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`