Skip to content

Commit d5e9a51

Browse files
committed
Update docstring of reduce_hypot function to use math where applicable
1 parent dc9354a commit d5e9a51

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

dpnp/dpnp_iface_trigonometric.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2107,14 +2107,15 @@ def logsumexp(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
21072107

21082108

21092109
def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
2110-
"""
2110+
r"""
21112111
Calculates the square root of the sum of squares of elements in
21122112
the input array.
21132113
21142114
Parameters
21152115
----------
21162116
x : {dpnp.ndarray, usm_ndarray}
2117-
Input array, expected to have a real-valued floating-point data type.
2117+
Input array, expected to have a boolean or real-valued floating-point
2118+
data type.
21182119
axis : {None, int or tuple of ints}, optional
21192120
Axis or axes along which values must be computed. If a tuple of unique
21202121
integers, values are computed over multiple axes. If ``None``, the
@@ -2159,15 +2160,14 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
21592160
has the data type as described in the `dtype` parameter description
21602161
above.
21612162
2163+
See Also
2164+
--------
2165+
:obj:`dpnp.hypot` : Calculates :math:`\sqrt{x1^2 + x2^2}`, element-wise.
2166+
21622167
Note
21632168
----
21642169
This function is equivalent of `numpy.hypot.reduce`.
21652170
2166-
See Also
2167-
--------
2168-
:obj:`dpnp.hypot` : Given the "legs" of a right triangle, return its
2169-
hypotenuse.
2170-
21712171
Examples
21722172
--------
21732173
>>> import dpnp as np

0 commit comments

Comments
 (0)