summaryrefslogtreecommitdiffstatshomepage
path: root/docs/reference/speed_python.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-15 17:24:56 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-04-15 17:24:56 +0300
commit6c84f1e03a87ff33a9130ff0527a74d4986ac3c5 (patch)
tree50c6d800316354489061c9dc6864237058bfe7ed /docs/reference/speed_python.rst
parentf474e956d74e3265b711d91adc5350f8e9c5f41c (diff)
downloadmicropython-6c84f1e03a87ff33a9130ff0527a74d4986ac3c5.tar.gz
micropython-6c84f1e03a87ff33a9130ff0527a74d4986ac3c5.zip
docs/speed_python: Clarify/generalize "Buffers" subsection.
Diffstat (limited to 'docs/reference/speed_python.rst')
-rw-r--r--docs/reference/speed_python.rst10
1 files changed, 4 insertions, 6 deletions
diff --git a/docs/reference/speed_python.rst b/docs/reference/speed_python.rst
index 4792a6fa97..31b5aeadda 100644
--- a/docs/reference/speed_python.rst
+++ b/docs/reference/speed_python.rst
@@ -59,12 +59,10 @@ An example of the above is the common case where a buffer is required, such as o
used for communication with a device. A typical driver will create the buffer in the
constructor and use it in its I/O methods which will be called repeatedly.
-The MicroPython libraries typically provide optional support for pre-allocated buffers.
-For example the ``uart.readinto()`` method allows two options for its argument, an integer
-or a buffer. If an integer is supplied it will read up to that number of bytes and
-return the outcome: this implies that a buffer is created with a corresponding
-memory allocation. Providing a pre-allocated buffer as the argument avoids this. See
-the code fragment in :ref:`Caching object references <Caching>` below.
+The MicroPython libraries typically provide support for pre-allocated buffers. For
+example, objects which support stream interface (e.g., file or UART) provide ``read()``
+method which allocate new buffer for read data, but also a ``readinto()`` method
+to read data into an existing buffer.
Floating Point
~~~~~~~~~~~~~~