Merge pull request #17627 from takanori-pskq/i13114-array-struct

DOC: Fix the references for ``__array_*__``

6 files changed, 15 insertions, 15 deletions

diff --git a/doc/source/reference/arrays.dtypes.rst b/doc/source/reference/arrays.dtypes.rst
index 8f664cd19..b5ffa1a8b 100644
--- a/doc/source/reference/arrays.dtypes.rst
+++ b/doc/source/reference/arrays.dtypes.rst
@@ -344,7 +344,7 @@ Type strings
 ``[(field_name, field_dtype, field_shape), ...]``
    *obj* should be a list of fields where each field is described by a
    tuple of length 2 or 3. (Equivalent to the ``descr`` item in the
-   :obj:`__array_interface__` attribute.)
+   :obj:`~object.__array_interface__` attribute.)
 
    The first element, *field_name*, is the field name (if this is
    ``''`` then a standard field name, ``'f#'``, is assigned).  The
diff --git a/doc/source/reference/arrays.interface.rst b/doc/source/reference/arrays.interface.rst
index d0a1c06c4..6a8c5f9c4 100644
--- a/doc/source/reference/arrays.interface.rst
+++ b/doc/source/reference/arrays.interface.rst
@@ -49,9 +49,9 @@ Python side
 ===========
 
 This approach to the interface consists of the object having an
-:data:`__array_interface__` attribute.
+:data:`~object.__array_interface__` attribute.
 
-.. data:: __array_interface__
+.. data:: object.__array_interface__
 
    A dictionary of items (3 required and 5 optional).  The optional
    keys in the dictionary have implied defaults if they are not
@@ -189,7 +189,7 @@ C-struct access
 This approach to the array interface allows for faster access to an
 array using only one attribute lookup and a well-defined C-structure.
 
-.. c:var:: __array_struct__
+.. data:: object.__array_struct__
 
    A :c:type:`PyCapsule` whose ``pointer`` member contains a
    pointer to a filled :c:type:`PyArrayInterface` structure.  Memory
@@ -248,7 +248,7 @@ Type description examples
 =========================
 
 For clarity it is useful to provide some examples of the type
-description and corresponding :data:`__array_interface__` 'descr'
+description and corresponding :data:`~object.__array_interface__` 'descr'
 entries.  Thanks to Scott Gilbert for these examples:
 
 In every case, the 'descr' key is optional, but of course provides
diff --git a/doc/source/reference/arrays.ndarray.rst b/doc/source/reference/arrays.ndarray.rst
index 405ae8f6a..6b805904a 100644
--- a/doc/source/reference/arrays.ndarray.rst
+++ b/doc/source/reference/arrays.ndarray.rst
@@ -259,10 +259,10 @@ Array interface
 
 .. seealso:: :ref:`arrays.interface`.
 
-==========================  ===================================
-:obj:`__array_interface__`  Python-side of the array interface
-:obj:`__array_struct__`     C-side of the array interface
-==========================  ===================================
+==================================  ===================================
+:obj:`~object.__array_interface__`  Python-side of the array interface
+:obj:`~object.__array_struct__`     C-side of the array interface
+==================================  ===================================
 
 :mod:`ctypes` foreign function interface
 ----------------------------------------
diff --git a/doc/source/reference/arrays.scalars.rst b/doc/source/reference/arrays.scalars.rst
index 24393f1e7..4b5da2e13 100644
--- a/doc/source/reference/arrays.scalars.rst
+++ b/doc/source/reference/arrays.scalars.rst
@@ -362,7 +362,7 @@ Attributes
 ==========
 
 The array scalar objects have an :obj:`array priority
-<__array_priority__>` of :c:data:`NPY_SCALAR_PRIORITY`
+<class.__array_priority__>` of :c:data:`NPY_SCALAR_PRIORITY`
 (-1,000,000.0). They also do not (yet) have a :attr:`ctypes <ndarray.ctypes>`
 attribute. Otherwise, they share the same attributes as arrays:
 
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*.