From a2eea57b1d5456696598703aa4ffdbc7e9fb52ea Mon Sep 17 00:00:00 2001 From: Damien George Date: Tue, 22 Oct 2019 16:40:58 +1100 Subject: docs/library: Rename "array" module to "uarray". --- docs/library/array.rst | 29 ----------------------------- docs/library/index.rst | 2 +- docs/library/uarray.rst | 29 +++++++++++++++++++++++++++++ 3 files changed, 30 insertions(+), 30 deletions(-) delete mode 100644 docs/library/array.rst create mode 100644 docs/library/uarray.rst (limited to 'docs') diff --git a/docs/library/array.rst b/docs/library/array.rst deleted file mode 100644 index f837b0343..000000000 --- a/docs/library/array.rst +++ /dev/null @@ -1,29 +0,0 @@ -:mod:`array` -- arrays of numeric data -====================================== - -.. module:: array - :synopsis: efficient arrays of numeric data - -|see_cpython_module| :mod:`python:array`. - -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 *iterable*. If it is not provided, an empty - array is created. - - .. method:: append(val) - - Append new element *val* to the end of array, growing it. - - .. method:: extend(iterable) - - Append new elements as contained in *iterable* to the end of - array, growing it. diff --git a/docs/library/index.rst b/docs/library/index.rst index dc89766e2..223304881 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -74,12 +74,12 @@ it will fallback to loading the built-in ``ujson`` module. :maxdepth: 1 builtins.rst - array.rst bluetooth.rst cmath.rst gc.rst math.rst sys.rst + uarray.rst ubinascii.rst ucollections.rst uerrno.rst diff --git a/docs/library/uarray.rst b/docs/library/uarray.rst new file mode 100644 index 000000000..9fa82ff31 --- /dev/null +++ b/docs/library/uarray.rst @@ -0,0 +1,29 @@ +:mod:`uarray` -- arrays of numeric data +======================================= + +.. module:: uarray + :synopsis: efficient arrays of numeric data + +|see_cpython_module| :mod:`python:array`. + +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(typecode, [iterable]) + + Create array with elements of given type. Initial contents of the + array are given by *iterable*. If it is not provided, an empty + array is created. + + .. method:: append(val) + + Append new element *val* to the end of array, growing it. + + .. method:: extend(iterable) + + Append new elements as contained in *iterable* to the end of + array, growing it. -- cgit v1.2.3