diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2015-01-28 23:11:47 -0500 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2015-01-28 23:11:47 -0500 |
commit | 8149c36abb651480202ff55a9b80efda9278be0f (patch) | |
tree | 79da6016bab5f25fe96fdcbf61ad6c106d667e31 | |
parent | 0a7fe2e6c29a2007a32a6386b0762bf1a6fdffc6 (diff) | |
parent | a7743d484ea829a941f08304c3a119e4e3f9d668 (diff) | |
download | numpy-8149c36abb651480202ff55a9b80efda9278be0f.tar.gz |
Merge pull request #5517 from jaimefrio/array_interface_doc
DOC: Update docs for PyArray_FromInterface/PyArray_FromStructInterface
-rw-r--r-- | doc/source/reference/c-api.array.rst | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst index 5911eaa68..f5f753292 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -593,18 +593,16 @@ From other objects .. cfunction:: PyObject* PyArray_FromStructInterface(PyObject* op) Returns an ndarray object from a Python object that exposes the - :obj:`__array_struct__`` method and follows the array interface - protocol. If the object does not contain this method then a + :obj:`__array_struct__` attribute and follows the array interface + protocol. If the object does not contain this attribute then a borrowed reference to :cdata:`Py_NotImplemented` is returned. .. cfunction:: PyObject* PyArray_FromInterface(PyObject* op) Returns an ndarray object from a Python object that exposes the - :obj:`__array_shape__` and :obj:`__array_typestr__` - methods following - the array interface protocol. If the object does not contain one - of these method then a borrowed reference to :cdata:`Py_NotImplemented` - is returned. + :obj:`__array_interface__` attribute following the array interface + protocol. If the object does not contain this attribute then a + borrowed reference to :cdata:`Py_NotImplemented` is returned. .. cfunction:: PyObject* PyArray_FromArrayAttr(PyObject* op, PyArray_Descr* dtype, PyObject* context) |