summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJulian Taylor <jtaylor.debian@googlemail.com>2014-12-10 20:23:33 +0100
committerJulian Taylor <jtaylor.debian@googlemail.com>2014-12-10 20:23:33 +0100
commit629735bf25589d5551f9e5c1c5c3194d25511260 (patch)
tree770cfd07311371be5f5b3242cf9c9010d813a34b /doc
parentcf2dc930e7b7f737445e8698041b5d98f6f88c4e (diff)
parent8df7eddd48584606310790be6d8d0d6b36671297 (diff)
downloadnumpy-629735bf25589d5551f9e5c1c5c3194d25511260.tar.gz
Merge pull request #5287 from chatcannon/reconcile-c-api-with-docs
Reconcile C API with docs
Diffstat (limited to 'doc')
-rw-r--r--doc/source/reference/c-api.array.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index e3723c46f..4015e2f35 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -108,10 +108,13 @@ sub-types).
.. cfunction:: int PyArray_FLAGS(PyArrayObject* arr)
-.. cfunction:: int PyArray_ITEMSIZE(PyArrayObject* arr)
+.. cfunction:: npy_intp PyArray_ITEMSIZE(PyArrayObject* arr)
Return the itemsize for the elements of this array.
+ Note that, in the old API that was deprecated in version 1.7, this function
+ had the return type ``int``.
+
.. cfunction:: int PyArray_TYPE(PyArrayObject* arr)
Return the (builtin) typenumber for the elements of this array.