summaryrefslogtreecommitdiff
path: root/numpy/lib/utils.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/lib/utils.py')
-rw-r--r--numpy/lib/utils.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/numpy/lib/utils.py b/numpy/lib/utils.py
index 931669fc1..cd5bb51e7 100644
--- a/numpy/lib/utils.py
+++ b/numpy/lib/utils.py
@@ -1002,7 +1002,7 @@ def safe_eval(source):
return ast.literal_eval(source)
-def _median_nancheck(data, result, axis, out):
+def _median_nancheck(data, result, axis):
"""
Utility function to check median result from data for NaN values at the end
and return NaN in that case. Input result can also be a MaskedArray.
@@ -1012,16 +1012,16 @@ def _median_nancheck(data, result, axis, out):
data : array
Input data to median function
result : Array or MaskedArray
- Result of median function
+ Result of median function.
axis : int
Axis along which the median was computed.
- out : ndarray, optional
- Output array in which to place the result.
Returns
-------
- median : scalar or ndarray
- Median or NaN in axes which contained NaN in the input.
+ result : scalar or ndarray
+ Median or NaN in axes which contained NaN in the input. If the input
+ was an array, NaN will be inserted in-place. If a scalar, either the
+ input itself or a scalar NaN.
"""
if data.size == 0:
return result