diff options
| author | yuki <drsuaimqjgar@gmail.com> | 2023-03-31 01:36:42 +0000 |
|---|---|---|
| committer | yuki <drsuaimqjgar@gmail.com> | 2023-04-10 10:41:14 +0000 |
| commit | 6c9b7a25853f6fea7170bc036b64653148c37a64 (patch) | |
| tree | 9e75c55f447b52b2608efdb6b6b6d7b5867bc843 /doc/source/reference/c-api | |
| parent | 2ef217d279d13afa2399efee864b9f11f4096aa7 (diff) | |
| download | numpy-6c9b7a25853f6fea7170bc036b64653148c37a64.tar.gz | |
DOC: Add directive for C-type `PyArrayMapIterObject`
`PyArrayMapIterObject` is referenced from other documents (e.g.
https://numpy.org/devdocs/reference/c-api/array.html#c.PyArray_MapIterSwapAxes),
however it has no target and causes reference warning (see gh-13114).
Therefore added directive `.. c:type:: PyArrayMapIterObject` to fix these references.
Diffstat (limited to 'doc/source/reference/c-api')
| -rw-r--r-- | doc/source/reference/c-api/types-and-structures.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/source/reference/c-api/types-and-structures.rst b/doc/source/reference/c-api/types-and-structures.rst index 5f76fe0a6..1fe7c0e93 100644 --- a/doc/source/reference/c-api/types-and-structures.rst +++ b/doc/source/reference/c-api/types-and-structures.rst @@ -1482,8 +1482,12 @@ for completeness and assistance in understanding the code. Advanced indexing is handled with this Python type. It is simply a loose wrapper around the C-structure containing the variables - needed for advanced array indexing. The associated C-structure, - ``PyArrayMapIterObject``, is useful if you are trying to + needed for advanced array indexing. + +.. c:type:: PyArrayMapIterObject + + The C-structure associated with :c:var:`PyArrayMapIter_Type`. + This structure is useful if you are trying to understand the advanced-index mapping code. It is defined in the ``arrayobject.h`` header. This type is not exposed to Python and could be replaced with a C-structure. As a Python type it takes |