summaryrefslogtreecommitdiff
path: root/docs/library/machine.UART.rst
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2016-11-14 23:31:40 +1100
committerDamien George <damien.p.george@gmail.com>2016-11-14 23:31:40 +1100
commita392b3aa75c9309afedd7e9d9f6aeb739c9d9dab (patch)
tree2177b540b85baa26f5ed95668cac838fd13bd990 /docs/library/machine.UART.rst
parentaed3b5b7baa379b991be8d15f5a3e39ba90967a4 (diff)
docs: Remove references to readall() and update stream read() docs.
Diffstat (limited to 'docs/library/machine.UART.rst')
-rw-r--r--docs/library/machine.UART.rst11
1 files changed, 3 insertions, 8 deletions
diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst
index f832cf466..0b6b24e89 100644
--- a/docs/library/machine.UART.rst
+++ b/docs/library/machine.UART.rst
@@ -31,7 +31,7 @@ A UART object acts like a stream object and reading and writing is done
using the standard stream methods::
uart.read(10) # read 10 characters, returns a bytes object
- uart.readall() # read all available characters
+ uart.read() # read all available characters
uart.readline() # read a line
uart.readinto(buf) # read and store into the given buffer
uart.write('abc') # write the 3 characters
@@ -95,17 +95,12 @@ Methods
.. method:: UART.read([nbytes])
- Read characters. If ``nbytes`` is specified then read at most that many bytes.
+ Read characters. If ``nbytes`` is specified then read at most that many bytes,
+ otherwise read as much data as possible.
Return value: a bytes object containing the bytes read in. Returns ``None``
on timeout.
-.. method:: UART.readall()
-
- Read as much data as possible.
-
- Return value: a bytes object or ``None`` on timeout.
-
.. method:: UART.readinto(buf[, nbytes])
Read bytes into the ``buf``. If ``nbytes`` is specified then read at most