summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library
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
parentaed3b5b7baa379b991be8d15f5a3e39ba90967a4 (diff)
downloadmicropython-a392b3aa75c9309afedd7e9d9f6aeb739c9d9dab.tar.gz
micropython-a392b3aa75c9309afedd7e9d9f6aeb739c9d9dab.zip
docs: Remove references to readall() and update stream read() docs.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/machine.UART.rst11
-rw-r--r--docs/library/pyb.UART.rst11
-rw-r--r--docs/library/pyb.USB_VCP.rst10
-rw-r--r--docs/library/usocket.rst8
4 files changed, 12 insertions, 28 deletions
diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst
index f832cf4664..0b6b24e894 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
diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst
index 4a692469f8..b6c0d1a20f 100644
--- a/docs/library/pyb.UART.rst
+++ b/docs/library/pyb.UART.rst
@@ -27,7 +27,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
@@ -122,6 +122,9 @@ Methods
If ``nbytes`` are available in the buffer, returns immediately, otherwise returns
when sufficient characters arrive or the timeout elapses.
+ If ``nbytes`` is not given then the method reads as much data as possible. It
+ returns after the timeout has elapsed.
+
.. only:: port_pyboard
*Note:* for 9 bit characters each character takes two bytes, ``nbytes`` must
@@ -130,12 +133,6 @@ Methods
Return value: a bytes object containing the bytes read in. Returns ``None``
on timeout.
-.. method:: UART.readall()
-
- Read as much data as possible. Returns after the timeout has elapsed.
-
- Return value: a bytes object or ``None`` if timeout prevents any data being read.
-
.. method:: UART.readchar()
Receive a single character on the bus.
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst
index 4e34af2586..4c4fe45168 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
diff --git a/docs/library/usocket.rst b/docs/library/usocket.rst
index 9b279e5ba7..e3b2b45014 100644
--- a/docs/library/usocket.rst
+++ b/docs/library/usocket.rst
@@ -178,14 +178,10 @@ Methods
Closing the file object returned by makefile() WILL close the
original socket as well.
- .. method:: socket.read(size)
+ .. method:: socket.read([size])
Read up to size bytes from the socket. Return a bytes object. If ``size`` is not given, it
- behaves just like ``socket.readall()``, see below.
-
- .. method:: socket.readall()
-
- Read all data available from the socket until ``EOF``. This function will not return until
+ reads all data available from the socket until ``EOF``; as such the method will not return until
the socket is closed.
.. method:: socket.readinto(buf[, nbytes])