Skip to content

Commit

Permalink
DOC: Fix warning for PyArray_MapIterNew. (#24130)
Browse files Browse the repository at this point in the history
Remove linked reference to PyArray_MapIterNew, which is part of the
C-API that is not recommended for direct use.

Fixes two sphinx nitpick link warnings.

Co-authored-by: Ross Barnowski <rossbar@caltech.edu>
  • Loading branch information
liang3zy22 and rossbar committed Jul 9, 2023
1 parent 548aa74 commit 1222ed5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/source/dev/internals.code-explanations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ has three different branches and one special case:
as if there is no subarray but needs some care during setup.

Deciding what case applies, checking broadcasting, and determining the kind
of transposition needed are all done in :c:func:`PyArray_MapIterNew`. After
of transposition needed are all done in ``PyArray_MapIterNew``. After
setting up, there are two cases. If there is no subarray or it only has one
element, no subarray iteration is necessary and an iterator is prepared
which iterates all indexing arrays *as well as* the result or value array.
Expand All @@ -283,7 +283,7 @@ iteration.

When advanced indices are next to each other transposing may be necessary.
All necessary transposing is handled by :c:func:`PyArray_MapIterSwapAxes` and
has to be handled by the caller unless :c:func:`PyArray_MapIterNew` is asked to
has to be handled by the caller unless ``PyArray_MapIterNew`` is asked to
allocate the result.

After preparation, getting and setting are relatively straightforward,
Expand Down

0 comments on commit 1222ed5

Please sign in to comment.