From 8777d059bbb3f6bd52c8fb43ed5ddfa9951f44ef Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Tue, 25 Oct 2022 19:23:08 -0700 Subject: [PATCH] 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> --- Doc/library/asyncio-stream.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index ce88d70d6607..d87e3c042c99 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` -- 2.47.3