summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/uasyncio.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/library/uasyncio.rst b/docs/library/uasyncio.rst
index 0c7170242..0abbf8dd8 100644
--- a/docs/library/uasyncio.rst
+++ b/docs/library/uasyncio.rst
@@ -237,9 +237,11 @@ TCP stream connections
This is a coroutine.
-.. method:: Stream.read(n)
+.. method:: Stream.read(n=-1)
- Read up to *n* bytes and return them.
+ Read up to *n* bytes and return them. If *n* is not provided or -1 then read all
+ bytes until EOF. The returned value will be an empty bytes object if EOF is
+ encountered before any bytes are read.
This is a coroutine.