diff options
-rw-r--r-- | numpy/core/_add_newdocs.py | 10 | ||||
-rw-r--r-- | numpy/core/code_generators/ufunc_docstrings.py | 10 |
2 files changed, 12 insertions, 8 deletions
diff --git a/numpy/core/_add_newdocs.py b/numpy/core/_add_newdocs.py index 3a05ad4bd..9ca7d9c56 100644 --- a/numpy/core/_add_newdocs.py +++ b/numpy/core/_add_newdocs.py @@ -5655,10 +5655,12 @@ add_newdoc('numpy.core', 'ufunc', number of outputs; use `None` for uninitialized outputs to be allocated by the ufunc. where : array_like, optional - Broadcast over the input. If the value is True, output will be set - to the ufunc output; otherwise it is left unchanged. Note that if an - uninitialized return array is created via the default ``out=None``, - output where the values are False will remain uninitialized. + This condition is broadcast over the input. At locations where the + condition is True, the `out` array will be set to the ufunc result. + Elsewhere, the `out` array will retain its original value. + Note that if an uninitialized `out` array is created via the default + ``out=None``, locations within it where the condition is False will + remain uninitialized. **kwargs For other keyword-only arguments, see the :ref:`ufunc docs <ufuncs.kwargs>`. diff --git a/numpy/core/code_generators/ufunc_docstrings.py b/numpy/core/code_generators/ufunc_docstrings.py index e7b3b3b4e..3ece11c3e 100644 --- a/numpy/core/code_generators/ufunc_docstrings.py +++ b/numpy/core/code_generators/ufunc_docstrings.py @@ -26,10 +26,12 @@ subst = { a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs. where : array_like, optional - Broadcast over the input. If the value is True, output will be set - to the ufunc output; otherwise it is left unchanged. Note that if an - uninitialized return array is created via the default ``out=None``, - output where the values are False will remain uninitialized. + This condition is broadcast over the input. At locations where the + condition is True, the `out` array will be set to the ufunc result. + Elsewhere, the `out` array will retain its original value. + Note that if an uninitialized `out` array is created via the default + ``out=None``, locations within it where the condition is False will + remain uninitialized. **kwargs For other keyword-only arguments, see the :ref:`ufunc docs <ufuncs.kwargs>`. |