From bb3ae05f773e1997b4e95655cf1795cb7c8f904b Mon Sep 17 00:00:00 2001 From: Jaime Fernandez Date: Sun, 1 Mar 2015 22:34:01 -0800 Subject: ENH: ufuncs can take a tuple of arrays as 'out' kwarg Closes #4752 --- doc/source/reference/ufuncs.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'doc/source') 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* -- cgit v1.2.1