summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephan Hoyer <shoyer@google.com>2019-05-25 14:21:20 -0700
committerStephan Hoyer <shoyer@google.com>2019-05-25 14:21:20 -0700
commitd4214b9355d07f5c149273ae04f955fda8cefd93 (patch)
tree95575b9ef66bfd726c3c853c0ddfcbb823e47f07
parenta8ba10f32c3347606ec2adb47c2e9f7c87b060c9 (diff)
downloadnumpy-d4214b9355d07f5c149273ae04f955fda8cefd93.tar.gz
DOC: note support for NUMPY_EXPERIMENTAL_ARRAY_FUNCTION=0
-rw-r--r--doc/neps/nep-0018-array-function-protocol.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/neps/nep-0018-array-function-protocol.rst b/doc/neps/nep-0018-array-function-protocol.rst
index a4a49b30b..01bd22522 100644
--- a/doc/neps/nep-0018-array-function-protocol.rst
+++ b/doc/neps/nep-0018-array-function-protocol.rst
@@ -98,12 +98,15 @@ A prototype implementation can be found in
.. note::
- Dispatch with the ``__array_function__`` protocol has been implemented on
- NumPy's master branch but is not yet enabled by default. In NumPy 1.16,
- you will need to set the environment variable
- ``NUMPY_EXPERIMENTAL_ARRAY_FUNCTION=1`` before importing NumPy to test
- NumPy function overrides. We anticipate the protocol will be enabled by
- default in NumPy 1.17.
+ Dispatch with the ``__array_function__`` protocol has been implemented but is
+ not yet enabled by default:
+
+ - In NumPy 1.16, you need to set the environment variable
+ ``NUMPY_EXPERIMENTAL_ARRAY_FUNCTION=1`` before importing NumPy to test
+ NumPy function overrides.
+ - In NumPy 1.17, the protocol will be enabled by default, but can be disabled
+ with ``NUMPY_EXPERIMENTAL_ARRAY_FUNCTION=0``.
+ - Eventually, expect to ``__array_function__`` to always be enabled.
The interface
~~~~~~~~~~~~~