diff options
author | Stefan van der Walt <stefan@sun.ac.za> | 2006-10-10 23:15:58 +0000 |
---|---|---|
committer | Stefan van der Walt <stefan@sun.ac.za> | 2006-10-10 23:15:58 +0000 |
commit | f52ca5b51b089962f3870107b2a6b8ccdcae2286 (patch) | |
tree | af2474c4d1d73405c262215fcc1a06f90726c592 /numpy/add_newdocs.py | |
parent | 349a84138004e47925a39e5d7144b3b0f47d4389 (diff) | |
download | numpy-f52ca5b51b089962f3870107b2a6b8ccdcae2286.tar.gz |
Simplify mean and average docstrings.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r-- | numpy/add_newdocs.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 482de23f1..a7e7138af 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -826,11 +826,10 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('mean', """a.mean(axis=None, dtype=None) Average the array over the given axis. If the axis is None, - average over all dimensions of the array. If an integer axis - is given, this equals: - a.sum(axis, dtype) * 1.0 / len(a). - If axis is None, this equals: - a.sum(axis, dtype) * 1.0 / product(a.shape,axis=0) + average over all dimensions of the array. Equivalent to + + a.sum(axis, dtype) * 1.0 / size(a, axis). + The optional dtype argument is the data type for intermediate calculations in the sum.; |