summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api.array.rst
diff options
context:
space:
mode:
authorkritisingh1 <kritisingh1.ks@gmail.com>2019-06-30 19:21:33 +0530
committerkritisingh1 <kritisingh1.ks@gmail.com>2019-06-30 19:21:33 +0530
commit6332c9e19d882908b6f8b317f8a8a60887f7c5b5 (patch)
treec0d7dfdcd6cfb90781858ea92a1cb21e68b8b416 /doc/source/reference/c-api.array.rst
parent8d18405446cb1c7dc6db15be812a9b3fc531ede0 (diff)
downloadnumpy-6332c9e19d882908b6f8b317f8a8a60887f7c5b5.tar.gz
DOC: Refactor Array API documentation
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
-rw-r--r--doc/source/reference/c-api.array.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index bd6062b16..928eefe9f 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -20,10 +20,11 @@ Array API
Array structure and data access
-------------------------------
-These macros all access the :c:type:`PyArrayObject` structure members. The input
-argument, arr, can be any :c:type:`PyObject *<PyObject>` that is directly interpretable
-as a :c:type:`PyArrayObject *` (any instance of the :c:data:`PyArray_Type` and its
-sub-types).
+These macros access the :c:type:`PyArrayObject` structure members and are
+defined in ``ndarraytypes.h``. The input argument, *arr*, can be any
+:c:type:`PyObject *<PyObject>` that is directly interpretable as a
+:c:type:`PyArrayObject *` (any instance of the :c:data:`PyArray_Type`
+and itssub-types).
.. c:function:: int PyArray_NDIM(PyArrayObject *arr)