summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api
diff options
context:
space:
mode:
authorLaurenz Kremeyer <laurenz.kremeyer@mail.mcgill.ca>2022-12-01 09:22:06 -0500
committerLaurenz Kremeyer <laurenz.kremeyer@mail.mcgill.ca>2022-12-01 09:22:06 -0500
commit8b717c674374e25e6fae55144360116b0a565f00 (patch)
treefff06033c797746916243436c26525c07e8e056f /doc/source/reference/c-api
parent01d64079b05c9b0c57775d0bb97d1cb5d52d2512 (diff)
downloadnumpy-8b717c674374e25e6fae55144360116b0a565f00.tar.gz
DOC: misleading text lead to false hope
Diffstat (limited to 'doc/source/reference/c-api')
-rw-r--r--doc/source/reference/c-api/iterator.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/reference/c-api/iterator.rst b/doc/source/reference/c-api/iterator.rst
index 07187e7f1..09c61e5fc 100644
--- a/doc/source/reference/c-api/iterator.rst
+++ b/doc/source/reference/c-api/iterator.rst
@@ -26,7 +26,7 @@ which may be of interest for those using this C API. In many instances,
testing out ideas by creating the iterator in Python is a good idea
before writing the C iteration code.
-Simple Iteration Example
+Iteration Example
------------------------
The best way to become familiar with the iterator is to look at its
@@ -115,10 +115,10 @@ number of non-zero elements in an array.
return nonzero_count;
}
-Simple Multi-Iteration Example
+Multi-Iteration Example
------------------------------
-Here is a simple copy function using the iterator. The ``order`` parameter
+Here is a copy function using the iterator. The ``order`` parameter
is used to control the memory layout of the allocated result, typically
:c:data:`NPY_KEEPORDER` is desired.