summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2018-05-15 20:11:56 +0300
committerCharles Harris <charlesr.harris@gmail.com>2018-05-15 11:11:56 -0600
commit9584c2f8ed78194ec18d20aea9616d4a89ee74fa (patch)
treedabbb34bd2491c8a0cf7b179ea901ecd5e331da9 /numpy/add_newdocs.py
parent5023c3b8decf91f435676e0e3767a3ca68eee316 (diff)
downloadnumpy-9584c2f8ed78194ec18d20aea9616d4a89ee74fa.tar.gz
DOC: Mention we can return unitinitialized values (#11086)
* DOC: mention we can return unitinitialized values * squash and rebase, extend explanation and improve docstring template * MAINT: Spelling fixes for docstrings. [ci skip] * MAINT: Update following feedback.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py10
1 files changed, 7 insertions, 3 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index 947004001..e8030d562 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -5647,10 +5647,13 @@ add_newdoc('numpy.core', 'ufunc',
Alternate array object(s) in which to put the result; if provided, it
must have a shape that the inputs broadcast to. A tuple of arrays
(possible only as a keyword argument) must have length equal to the
- number of outputs; use `None` for outputs to be allocated by the ufunc.
+ number of outputs; use `None` for uninitialized outputs to be
+ allocated by the ufunc.
where : array_like, optional
Values of True indicate to calculate the ufunc at that position, values
- of False indicate to leave the value in the output alone.
+ of False indicate to leave the value in the output alone. Note that if
+ an uninitialized return array is created via the default ``out=None``,
+ then the elements where the values are False will remain uninitialized.
**kwargs
For other keyword-only arguments, see the :ref:`ufunc docs <ufuncs.kwargs>`.
@@ -5658,7 +5661,8 @@ add_newdoc('numpy.core', 'ufunc',
-------
r : ndarray or tuple of ndarray
`r` will have the shape that the arrays in `x` broadcast to; if `out` is
- provided, `r` will be equal to `out`. If the function has more than one
+ provided, it will be returned. If not, `r` will be allocated and
+ may contain uninitialized values. If the function has more than one
output, then the result will be a tuple of arrays.
""")