summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorJaime Fernandez <jaime.frio@gmail.com>2015-03-01 22:34:01 -0800
committerJaime Fernandez <jaime.frio@gmail.com>2015-03-08 09:00:03 -0700
commitbb3ae05f773e1997b4e95655cf1795cb7c8f904b (patch)
tree152069c2dc99f41a38778ae93818a5f54484fe87 /doc/source
parent50e4eb87370b77792f1f6d21a5edd6ff20abee68 (diff)
downloadnumpy-bb3ae05f773e1997b4e95655cf1795cb7c8f904b.tar.gz
ENH: ufuncs can take a tuple of arrays as 'out' kwarg
Closes #4752
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/reference/ufuncs.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/source/reference/ufuncs.rst b/doc/source/reference/ufuncs.rst
index 3d6112058..f7142bc47 100644
--- a/doc/source/reference/ufuncs.rst
+++ b/doc/source/reference/ufuncs.rst
@@ -299,7 +299,20 @@ advanced usage and will not typically be used.
.. versionadded:: 1.6
- The first output can provided as either a positional or a keyword parameter.
+ The first output can be provided as either a positional or a keyword
+ parameter. Keyword 'out' arguments are incompatible with positional
+ ones.
+
+ ..versionadded:: 1.10
+
+ The 'out' keyword argument is expected to be a tuple with one entry per
+ output (which can be `None` for arrays to be allocated by the ufunc).
+ For ufuncs with a single output, passing a single array (instead of a
+ tuple holding a single array) is also valid.
+
+ Passing a single array in the 'out' keyword argument to a ufunc with
+ multiple outputs is deprecated, and will raise a warning in numpy 1.10,
+ and an error in a future release.
*where*