From f30f986b439c7da621ea6402b4f883e28f05a5d4 Mon Sep 17 00:00:00 2001 From: Sebastian Berg Date: Tue, 25 Aug 2015 19:54:22 +0200 Subject: 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. --- doc/source/reference/c-api.iterator.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/source/reference/c-api.iterator.rst') 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) -- cgit v1.2.1