Skip to content

bpo-36889: Document Stream class and add docstrings #14488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miss-islington merged 9 commits into from
Sep 13, 2019
Merged

bpo-36889: Document Stream class and add docstrings #14488

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7ed4629
Document Stream and add docstrings
tirkarthi Jun 25, 2019
e2a64ad
Remove 3.7 example and group the functions
tirkarthi Jun 25, 2019
19798d5
Fix tabs error
tirkarthi Jul 1, 2019
8ac5116
Add methods to API index and remove deprecated methods.
tirkarthi Sep 10, 2019
479a860
Add deprecations to index. Reword few sentences.
tirkarthi Sep 10, 2019
df72ef4
Remove reference to stream.drain. Add a note on stream.write as a met…
tirkarthi Sep 11, 2019
99fefef
Add deprecated notes to recommend await stream.write
tirkarthi Sep 13, 2019
c191de6
Fix write to writelines.
tirkarthi Sep 13, 2019
623afb5
Sort the methods by alphabet.
tirkarthi Sep 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix write to writelines.
  • Loading branch information
@tirkarthi
tirkarthi committed Sep 13, 2019
commit c191de6f8456585d9a75f220f12c6cfbc78c1d78
4 changes: 2 additions & 2 deletions Doc/library/asyncio-stream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ Stream
If that fails, the data is queued in an internal write buffer until it can be
sent.

It is possible to directly await on the `write()` method::
It is possible to directly await on the `writelines()` method::

await stream.writelines(lines)

Expand Down Expand Up @@ -673,7 +673,7 @@ StreamWriter
If that fails, the data is queued in an internal write buffer until it can be
sent.

Starting with Python 3.8, it is possible to directly await on the `write()`
Starting with Python 3.8, it is possible to directly await on the `writelines()`
method::

await stream.writelines(lines)
Expand Down