gh-84747: Add `async for` comment for StreamReader (GH-98633)

(cherry picked from commit 4196ee5c8b)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2022-10-25 19:23:08 -07:00 committed by GitHub
parent 83c8df29dd
commit 8777d059bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions

View File

@ -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`