summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark Wiebe <mwwiebe@gmail.com>2011-08-15 11:31:39 -0700
committerCharles Harris <charlesr.harris@gmail.com>2011-08-25 20:09:42 -0600
commit09a750c61e816ce16927c5621e97803f542dbf38 (patch)
tree8979c8765dc586e37c535887807d1600539f32d5 /doc
parent02b1c207cae97b0c0504107bf081cd0ccd3752d7 (diff)
downloadnumpy-09a750c61e816ce16927c5621e97803f542dbf38.tar.gz
DOC: nditer: Add links to the nditer introductory doc to make it more discoverable
Diffstat (limited to 'doc')
-rw-r--r--doc/source/reference/arrays.nditer.rst2
-rw-r--r--doc/source/reference/c-api.iterator.rst5
2 files changed, 6 insertions, 1 deletions
diff --git a/doc/source/reference/arrays.nditer.rst b/doc/source/reference/arrays.nditer.rst
index eeabdfe11..f8f785a49 100644
--- a/doc/source/reference/arrays.nditer.rst
+++ b/doc/source/reference/arrays.nditer.rst
@@ -13,7 +13,7 @@ object for computations on arrays in Python, then concludes with how one
can accelerate the inner loop in Cython. Since the Python exposure of
:class:`nditer` is a relatively straightforward mapping of the C array
iterator API, these ideas will also provide help working with array
-iteration in C.
+iteration from C or C++.
Single Array Iteration
======================
diff --git a/doc/source/reference/c-api.iterator.rst b/doc/source/reference/c-api.iterator.rst
index 78d068192..01385acfd 100644
--- a/doc/source/reference/c-api.iterator.rst
+++ b/doc/source/reference/c-api.iterator.rst
@@ -23,6 +23,11 @@ branch, so will integrate naturally into the refactored code base.
The iterator is named ``NpyIter`` and functions are
named ``NpyIter_*``.
+There is an :ref:`introductory guide to array iteration <arrays.nditer>`
+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.
+
Converting from Previous NumPy Iterators
----------------------------------------