summaryrefslogtreecommitdiff
path: root/docs/library/pyb.USB_VCP.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/pyb.USB_VCP.rst
parentaed3b5b7baa379b991be8d15f5a3e39ba90967a4 (diff)
docs: Remove references to readall() and update stream read() docs.
Diffstat (limited to 'docs/library/pyb.USB_VCP.rst')
-rw-r--r--docs/library/pyb.USB_VCP.rst10
1 files changed, 3 insertions, 7 deletions
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst
index 4e34af258..4c4fe4516 100644
--- a/docs/library/pyb.USB_VCP.rst
+++ b/docs/library/pyb.USB_VCP.rst
@@ -44,16 +44,12 @@ Methods
.. method:: USB_VCP.read([nbytes])
Read at most ``nbytes`` from the serial device and return them as a
- bytes object. If ``nbytes`` is not specified then the method acts as
- ``readall()``. USB_VCP stream implicitly works in non-blocking mode,
+ bytes object. If ``nbytes`` is not specified then the method reads
+ all available bytes from the serial device.
+ USB_VCP stream implicitly works in non-blocking mode,
so if no pending data available, this method will return immediately
with ``None`` value.
-.. method:: USB_VCP.readall()
-
- Read all available bytes from the serial device and return them as
- a bytes object, or ``None`` if no pending data available.
-
.. method:: USB_VCP.readinto(buf, [maxlen])
Read bytes from the serial device and store them into ``buf``, which