diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2015-03-08 13:19:13 -0400 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2015-03-08 13:19:13 -0400 |
commit | bc034dcda527372080ced5b629dc317047ef9336 (patch) | |
tree | 35e138f1edd7f1b1559d91521a93d5326fa59fee /doc/source | |
parent | a0ea0593aea99ef139953e5c721302832699f629 (diff) | |
parent | bb3ae05f773e1997b4e95655cf1795cb7c8f904b (diff) | |
download | numpy-bc034dcda527372080ced5b629dc317047ef9336.tar.gz |
Merge pull request #5621 from jaimefrio/ufunc_out_tuple
ENH: ufuncs can take a tuple of arrays as 'out' kwarg
Diffstat (limited to 'doc/source')
-rw-r--r-- | doc/source/reference/ufuncs.rst | 15 |
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* |