diff options
author | Sebastian Berg <sebastian@sipsolutions.net> | 2015-08-25 19:54:22 +0200 |
---|---|---|
committer | Sebastian Berg <sebastian@sipsolutions.net> | 2015-08-26 11:10:03 +0200 |
commit | f30f986b439c7da621ea6402b4f883e28f05a5d4 (patch) | |
tree | 31fc119155158483ab797b2824f56811d3187ba4 /doc/source/reference/c-api.iterator.rst | |
parent | 447b619158a71b1372e8b22038e905621628bf79 (diff) | |
download | numpy-f30f986b439c7da621ea6402b4f883e28f05a5d4.tar.gz |
DOC: Add warning that the InnerStridesArray may change.
It may be that you can say that it cannot happen when grow inner
is not enabled as well.
Diffstat (limited to 'doc/source/reference/c-api.iterator.rst')
-rw-r--r-- | doc/source/reference/c-api.iterator.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/source/reference/c-api.iterator.rst b/doc/source/reference/c-api.iterator.rst index ce1210737..16beabcf0 100644 --- a/doc/source/reference/c-api.iterator.rst +++ b/doc/source/reference/c-api.iterator.rst @@ -1221,6 +1221,9 @@ functions provide that information. This pointer may be cached before the iteration loop, calling ``iternext`` will not change it. This function may be safely called without holding the Python GIL. + + **WARNING**: While the pointer may be cached, its values may + change if the iterator is buffered. .. c:function:: npy_intp* NpyIter_GetInnerLoopSizePtr(NpyIter* iter) |