summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSebastian Berg <sebastian@sipsolutions.net>2020-04-10 13:22:57 -0500
committerGitHub <noreply@github.com>2020-04-10 13:22:57 -0500
commit9005d7df9b644b3b3de55118b7f7ffa026e4284b (patch)
tree903f2b531db510939a3088c8ed75f681adc4074a /doc
parent1f3650643f341af8ca5c12529a479d73d3103895 (diff)
downloadnumpy-9005d7df9b644b3b3de55118b7f7ffa026e4284b.tar.gz
DOC: Update documentation w.r.t. NPY_RELAXED_STRIDES_CHECKING (gh-15907)
This has been the default for a very long time, so this was incorrect and mentioning any versions is probably not helpful.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/reference/arrays.ndarray.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/source/reference/arrays.ndarray.rst b/doc/source/reference/arrays.ndarray.rst
index 59a925e47..dec8c72c4 100644
--- a/doc/source/reference/arrays.ndarray.rst
+++ b/doc/source/reference/arrays.ndarray.rst
@@ -158,10 +158,12 @@ base offset itself is a multiple of `self.itemsize`. Understanding
.. note::
- Points (1) and (2) are not yet applied by default. Beginning with
- NumPy 1.8.0, they are applied consistently only if the environment
- variable ``NPY_RELAXED_STRIDES_CHECKING=1`` was defined when NumPy
- was built. Eventually this will become the default.
+ Points (1) and (2) can currently be disabled by the compile time
+ environmental variable ``NPY_RELAXED_STRIDES_CHECKING=0``,
+ which was the default before NumPy 1.10.
+ No users should have to do this. ``NPY_RELAXED_STRIDES_DEBUG=1``
+ can be used to help find errors when incorrectly relying on the strides
+ in C-extension code (see below warning).
You can check whether this option was enabled when your NumPy was
built by looking at the value of ``np.ones((10,1),