diff options
| author | Matti Picus <matti.picus@gmail.com> | 2020-10-25 08:03:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-25 08:03:52 +0200 |
| commit | 119a0330c9cbeb13fbf8801b4f5d956659ff92cc (patch) | |
| tree | 5c5a9e7ac61349c098a6f5f293641962c689bb52 /doc/source/reference/c-api | |
| parent | 56388f8f582b7800bc3af84958e2d1b0eae1bc05 (diff) | |
| parent | bc90452a095424bf837736a8615407ab4f1dd649 (diff) | |
| download | numpy-119a0330c9cbeb13fbf8801b4f5d956659ff92cc.tar.gz | |
Merge pull request #17627 from takanori-pskq/i13114-array-struct
DOC: Fix the references for ``__array_*__``
Diffstat (limited to 'doc/source/reference/c-api')
| -rw-r--r-- | doc/source/reference/c-api/array.rst | 4 | ||||
| -rw-r--r-- | doc/source/reference/c-api/types-and-structures.rst | 6 |
2 files changed, 5 insertions, 5 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index 2e7e84946..b22e20818 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -604,14 +604,14 @@ From other objects .. c:function:: PyObject* PyArray_FromStructInterface(PyObject* op) Returns an ndarray object from a Python object that exposes the - :obj:`__array_struct__` attribute and follows the array interface + :obj:`~object.__array_struct__` attribute and follows the array interface protocol. If the object does not contain this attribute then a borrowed reference to :c:data:`Py_NotImplemented` is returned. .. c:function:: PyObject* PyArray_FromInterface(PyObject* op) Returns an ndarray object from a Python object that exposes the - :obj:`__array_interface__` attribute following the array interface + :obj:`~object.__array_interface__` attribute following the array interface protocol. If the object does not contain this attribute then a borrowed reference to :c:data:`Py_NotImplemented` is returned. diff --git a/doc/source/reference/c-api/types-and-structures.rst b/doc/source/reference/c-api/types-and-structures.rst index 9b92e1391..87d4be6f3 100644 --- a/doc/source/reference/c-api/types-and-structures.rst +++ b/doc/source/reference/c-api/types-and-structures.rst @@ -1330,13 +1330,13 @@ PyArrayInterface The :c:type:`PyArrayInterface` structure is defined so that NumPy and other extension modules can use the rapid array interface - protocol. The :obj:`__array_struct__` method of an object that + protocol. The :obj:`~object.__array_struct__` method of an object that supports the rapid array interface protocol should return a :c:type:`PyCapsule` that contains a pointer to a :c:type:`PyArrayInterface` structure with the relevant details of the array. After the new array is created, the attribute should be ``DECREF``'d which will free the :c:type:`PyArrayInterface` structure. Remember to ``INCREF`` the - object (whose :obj:`__array_struct__` attribute was retrieved) and + object (whose :obj:`~object.__array_struct__` attribute was retrieved) and point the base member of the new :c:type:`PyArrayObject` to this same object. In this way the memory for the array will be managed correctly. @@ -1405,7 +1405,7 @@ PyArrayInterface .. c:member:: PyObject *descr A Python object describing the data-type in more detail (same - as the *descr* key in :obj:`__array_interface__`). This can be + as the *descr* key in :obj:`~object.__array_interface__`). This can be ``NULL`` if *typekind* and *itemsize* provide enough information. This field is also ignored unless :c:data:`NPY_ARR_HAS_DESCR` flag is on in *flags*. |