diff options
| author | Yug Khanna <yugkhanna1@gmail.com> | 2018-09-10 17:56:10 -0400 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2018-09-10 16:56:10 -0500 |
| commit | 457f3793831b9cfbacab8bd62876ca2fc10b7203 (patch) | |
| tree | a4f7ee8cb827f1667d3b2c6fa6fd4ae90d83629d /doc/source/reference/c-api.array.rst | |
| parent | dc6a5735519aca9aeedf1b8e83fefa1ae43131b3 (diff) | |
| download | numpy-457f3793831b9cfbacab8bd62876ca2fc10b7203.tar.gz | |
DOC: Clarify difference between PySequence_GETITEM, PyArray_GETITEM (#11914)
* Issue #10966 fix
* Issue #10966 fix
Added documentation for return of standard python types on success for `PyArray_GETITEM`
* Update c-api.array.rst
* Update c-api.array.rst
* Update c-api.array.rst
* Update c-api.array.rst
* Update c-api.array.rst
* Update c-api.array.rst
* Update c-api.array.rst
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
| -rw-r--r-- | doc/source/reference/c-api.array.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst index 5ea7bfcfc..9265b1a97 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -122,9 +122,11 @@ sub-types). .. c:function:: PyObject *PyArray_GETITEM(PyArrayObject* arr, void* itemptr) - Get a Python object from the ndarray, *arr*, at the location - pointed to by itemptr. Return ``NULL`` on failure. - + Get a Python object of a builtin type from the ndarray, *arr*, + at the location pointed to by itemptr. Return ``NULL`` on failure. + + `numpy.ndarray.item` is identical to PyArray_GETITEM. + .. c:function:: int PyArray_SETITEM( \ PyArrayObject* arr, void* itemptr, PyObject* obj) |