diff options
| author | Inessa Pawson <inessapawson@gmail.com> | 2022-10-19 13:01:30 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-19 10:01:30 -0700 |
| commit | 7776bc6166915322bc61c4be988fc99727bc2f9a (patch) | |
| tree | 423bf36bc57561d92b999a6edbfc4e6e532c8c8c /numpy/core/fromnumeric.py | |
| parent | a8449b52163f871b75a4873a9543db6612d38ccf (diff) | |
| download | numpy-7776bc6166915322bc61c4be988fc99727bc2f9a.tar.gz | |
DOC: Add note to clarify relationship between round and around (#21853)
Improve docstring to clarify the relationship between np.round and np.around
Co-authored-by: Mukulika Pahari <mukulikapahari@gmail.com>, Aparna Bushan <aparna.bushan@auto-grid.com>
Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Diffstat (limited to 'numpy/core/fromnumeric.py')
| -rw-r--r-- | numpy/core/fromnumeric.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 89d731e32..ca9d55cb7 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -3274,12 +3274,13 @@ def around(a, decimals=0, out=None): See Also -------- ndarray.round : equivalent method - ceil, fix, floor, rint, trunc Notes ----- + `~numpy.round` is often used as an alias for `~numpy.around`. + For values exactly halfway between rounded decimal values, NumPy rounds to the nearest even value. Thus 1.5 and 2.5 round to 2.0, -0.5 and 0.5 round to 0.0, etc. |