diff options
| author | Chris Kerr <cjk34@cam.ac.uk> | 2014-11-17 20:30:04 +0100 |
|---|---|---|
| committer | Chris Kerr <cjk34@cam.ac.uk> | 2014-11-17 20:36:28 +0100 |
| commit | 54bb07b723f6c1fc508e5021de8ef261ae366f6a (patch) | |
| tree | 240a4fbcbcfa8cc92dfa4992e922e4954d7e7f61 /doc/source/reference/c-api.array.rst | |
| parent | f14d5e1e520e9f598abf9881d50d403a24bd258c (diff) | |
| download | numpy-54bb07b723f6c1fc508e5021de8ef261ae366f6a.tar.gz | |
DOC: Update the docs for the C API to reflect the change in return type of PyArray_ITEMSIZE
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
| -rw-r--r-- | doc/source/reference/c-api.array.rst | 5 |
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. |