diff options
author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-08-07 00:13:48 +0300 |
---|---|---|
committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-08-07 00:13:48 +0300 |
commit | 8a0b6f561cd8a1e8ab61f3bebcaec48f57dcd63c (patch) | |
tree | b6cb2d344bd73abcb7efce716593ec14cf59116d /docs/library | |
parent | e15fb33e109983ced35f14c674e0aa1d47dbc357 (diff) | |
download | micropython-8a0b6f561cd8a1e8ab61f3bebcaec48f57dcd63c.tar.gz micropython-8a0b6f561cd8a1e8ab61f3bebcaec48f57dcd63c.zip |
docs/array: Document array module.
Diffstat (limited to 'docs/library')
-rw-r--r-- | docs/library/array.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/library/array.rst b/docs/library/array.rst new file mode 100644 index 0000000000..f52b4b385e --- /dev/null +++ b/docs/library/array.rst @@ -0,0 +1,30 @@ +:mod:`array` -- arrays of numeric data +====================================== + +.. module:: array + :synopsis: efficient arrays of numeric data + +See `Python array <https://docs.python.org/3/library/array.html>`_ for more +information. + +Supported format codes: ``b``, ``B``, ``h``, ``H``, ``i``, ``I``, ``l``, +``L``, ``q``, ``Q``, ``f``, ``d`` (the latter 2 depending on the +floating-point support). + +Classes +------- + +.. class:: array.array(typecode, [iterable]) + + Create array with elements of given type. Initial contents of the + array are given by an `iterable`. If it is not provided, an empty + array is created. + + .. method:: append(val) + + Append new element to the end of array, growing it. + + .. method:: extend(iterable) + + Append new elements as contained in an iterable to the end of + array, growing it. |