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/uarray.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 docs/library/uarray.rst

(limited to 'docs/library/uarray.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