From 457f3793831b9cfbacab8bd62876ca2fc10b7203 Mon Sep 17 00:00:00 2001 From: Yug Khanna Date: Mon, 10 Sep 2018 17:56:10 -0400 Subject: 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 --- doc/source/reference/c-api.array.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'doc/source/reference/c-api.array.rst') 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) -- cgit v1.2.1