diff options
author | Matthew Craig <mattwcraig@gmail.com> | 2015-02-08 15:21:43 -0600 |
---|---|---|
committer | Matthew Craig <mattwcraig@gmail.com> | 2015-02-08 15:21:43 -0600 |
commit | edb9399df2ee26563185acb37535f81f94563354 (patch) | |
tree | a5b7d6776e887ca949c79e688f7957f08ebcb4b3 /numpy/ma/extras.py | |
parent | 72f409cb1ec21aa8b6c28d0e82d5e26197e6b454 (diff) | |
download | numpy-edb9399df2ee26563185acb37535f81f94563354.tar.gz |
Update docstring of ma.extras.average to reflect actual behavior
Diffstat (limited to 'numpy/ma/extras.py')
-rw-r--r-- | numpy/ma/extras.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/numpy/ma/extras.py b/numpy/ma/extras.py index 9adb9d368..58f3f3067 100644 --- a/numpy/ma/extras.py +++ b/numpy/ma/extras.py @@ -497,8 +497,9 @@ def average(a, axis=None, weights=None, returned=False): The average along the specified axis. When returned is `True`, return a tuple with the average as the first element and the sum of the weights as the second element. The return type is `np.float64` - if `a` is of integer type, otherwise it is of the same type as `a`. - If returned, `sum_of_weights` is of the same type as `average`. + if `a` is of integer type and floats smaller than `float64`, or the + input data-type, otherwise. If returned, `sum_of_weights` is always + `float64`. Examples -------- |