diff options
author | takanori-pskq <takanori17h@gmail.com> | 2020-10-26 14:11:44 +0900 |
---|---|---|
committer | takanori-pskq <takanori17h@gmail.com> | 2020-10-26 15:55:50 +0900 |
commit | d212ee4ceeb0a1ff8dba1c6d9e0cc54360e81a94 (patch) | |
tree | e47fa552685820a398a0366f811b30f82a301d93 /doc/source/reference | |
parent | fcba5a6c901717110b9767b418df410d7c8c6e73 (diff) | |
download | numpy-d212ee4ceeb0a1ff8dba1c6d9e0cc54360e81a94.tar.gz |
DOC: Fix some references
Diffstat (limited to 'doc/source/reference')
-rw-r--r-- | doc/source/reference/arrays.ndarray.rst | 4 | ||||
-rw-r--r-- | doc/source/reference/arrays.nditer.cython.rst | 2 | ||||
-rw-r--r-- | doc/source/reference/c-api/array.rst | 8 | ||||
-rw-r--r-- | doc/source/reference/c-api/types-and-structures.rst | 3 | ||||
-rw-r--r-- | doc/source/reference/maskedarray.baseclass.rst | 4 |
5 files changed, 11 insertions, 10 deletions
diff --git a/doc/source/reference/arrays.ndarray.rst b/doc/source/reference/arrays.ndarray.rst index 6b805904a..191367058 100644 --- a/doc/source/reference/arrays.ndarray.rst +++ b/doc/source/reference/arrays.ndarray.rst @@ -1,11 +1,11 @@ +.. currentmodule:: numpy + .. _arrays.ndarray: ****************************************** The N-dimensional array (:class:`ndarray`) ****************************************** -.. currentmodule:: numpy - An :class:`ndarray` is a (usually fixed-size) multidimensional container of items of the same type and size. The number of dimensions and items in an array is defined by its :attr:`shape <ndarray.shape>`, diff --git a/doc/source/reference/arrays.nditer.cython.rst b/doc/source/reference/arrays.nditer.cython.rst index 2cc7763ed..43aad9927 100644 --- a/doc/source/reference/arrays.nditer.cython.rst +++ b/doc/source/reference/arrays.nditer.cython.rst @@ -5,7 +5,7 @@ Those who want really good performance out of their low level operations should strongly consider directly using the iteration API provided in C, but for those who are not comfortable with C or C++, Cython is a good middle ground with reasonable performance tradeoffs. For -the :class:`nditer` object, this means letting the iterator take care +the :class:`~numpy.nditer` object, this means letting the iterator take care of broadcasting, dtype conversion, and buffering, while giving the inner loop to Cython. diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index e9717d59a..7a3f0fb7c 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -2960,9 +2960,9 @@ to. already a buffer object pointing to another object). If you need to hold on to the memory be sure to INCREF the base member. The chunk of memory is pointed to by *buf* ->ptr member and has length - *buf* ->len. The flags member of *buf* is :c:data:`NPY_BEHAVED_RO` with - the :c:data:`NPY_ARRAY_WRITEABLE` flag set if *obj* has a writeable buffer - interface. + *buf* ->len. The flags member of *buf* is :c:data:`NPY_ARRAY_BEHAVED` + with the :c:data:`NPY_ARRAY_WRITEABLE` flag set if *obj* has + a writeable buffer interface. .. c:function:: int PyArray_AxisConverter(PyObject* obj, int* axis) @@ -3136,7 +3136,7 @@ the C-API is needed then some additional steps must be taken. be defined in another compilation unit. * Whenever :c:macro:`PY_ARRAY_UNIQUE_SYMBOL` is #defined, it also changes the name of the variable holding the C-API, which - defaults to :c:data:`PyArray_API`, to whatever the macro is + defaults to ``PyArray_API``, to whatever the macro is #defined to. Checking the API Version diff --git a/doc/source/reference/c-api/types-and-structures.rst b/doc/source/reference/c-api/types-and-structures.rst index 87d4be6f3..6a9c4a9cf 100644 --- a/doc/source/reference/c-api/types-and-structures.rst +++ b/doc/source/reference/c-api/types-and-structures.rst @@ -412,7 +412,8 @@ PyArrayDescr_Type and PyArray_Descr Metadata specific to the C implementation of the particular dtype. Added for NumPy 1.7.0. - .. c:member:: Npy_hash_t *hash + .. c:type:: npy_hash_t + .. c:member:: npy_hash_t *hash Currently unused. Reserved for future use in caching hash values. diff --git a/doc/source/reference/maskedarray.baseclass.rst b/doc/source/reference/maskedarray.baseclass.rst index 5c1bdda23..5a0f99651 100644 --- a/doc/source/reference/maskedarray.baseclass.rst +++ b/doc/source/reference/maskedarray.baseclass.rst @@ -242,8 +242,8 @@ Comparison operators: MaskedArray.__eq__ MaskedArray.__ne__ -Truth value of an array (:func:`bool()`): -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Truth value of an array (:class:`bool() <bool>`): +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ |