From 486878b37fc7439a3b2b87747f50db9b62fea8eb Mon Sep 17 00:00:00 2001 From: Inessa Pawson Date: Tue, 28 Feb 2023 14:02:40 -0500 Subject: DOC: Update the docstring for `np.round_` to disrecommend it (#22527) [skip ci] --- numpy/core/fromnumeric.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'numpy/core/fromnumeric.py') diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index e7366898e..7d3336f88 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -3748,14 +3748,18 @@ def var(a, axis=None, dtype=None, out=None, ddof=0, keepdims=np._NoValue, *, **kwargs) -# Aliases of other functions. These have their own definitions only so that -# they can have unique docstrings. +# Aliases of other functions. Provided unique docstrings +# are reference purposes only. Wherever possible, +# avoid using them. @array_function_dispatch(_around_dispatcher) def round_(a, decimals=0, out=None): """ Round an array to the given number of decimals. + `~numpy.round_` is a disrecommended backwards-compatibility + alias of `~numpy.around` and `~numpy.round`. + See Also -------- around : equivalent function; see for details. -- cgit v1.2.1