summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2018-11-12 17:17:24 -0600
committerGitHub <noreply@github.com>2018-11-12 17:17:24 -0600
commit067264b20f8d2c043cf5b9cd3d1826384e558e79 (patch)
tree4714149704808160daa1ee9b2bdaa9cfab2672d8 /doc
parente34f5bb4e3aad2bb35fb6d9e3a5c1bfc85eb97eb (diff)
parent9fa3a4e9802b32c985f6a1fc14dd315a2656ac38 (diff)
downloadnumpy-067264b20f8d2c043cf5b9cd3d1826384e558e79.tar.gz
Merge pull request #12362 from shoyer/disable-array-function-by-default
MAINT: disable `__array_function__` dispatch unless environment variable set
Diffstat (limited to 'doc')
-rw-r--r--doc/neps/nep-0018-array-function-protocol.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/neps/nep-0018-array-function-protocol.rst b/doc/neps/nep-0018-array-function-protocol.rst
index f558e60f2..988c9086a 100644
--- a/doc/neps/nep-0018-array-function-protocol.rst
+++ b/doc/neps/nep-0018-array-function-protocol.rst
@@ -95,6 +95,15 @@ A prototype implementation can be found in
of NumPy functions for non-NumPy arrays. See "Non-goals" below for more
details.
+.. 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.
+
The interface
~~~~~~~~~~~~~