Skip to content

Commit 0a29ded

Browse files
committed
Update docstring of sin and sinh functions to use math where applicable
1 parent d5e9a51 commit 0a29ded

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

dpnp/dpnp_iface_trigonometric.py

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ def _get_accumulation_res_dt(a, dtype):
753753

754754

755755
_COS_DOCSTRING = """
756-
Computes cosine for each element :math:`x_i` for input array `x`.
756+
Computes the cosine for each element :math:`x_i` for input array `x`.
757757
758758
For full documentation refer to :obj:`numpy.cos`.
759759
@@ -810,7 +810,7 @@ def _get_accumulation_res_dt(a, dtype):
810810

811811

812812
_COSH_DOCSTRING = r"""
813-
Computes hyperbolic cosine for each element :math:`x_i` for input array `x`.
813+
Computes the hyperbolic cosine for each element :math:`x_i` for input array `x`.
814814
815815
The mathematical definition of the hyperbolic cosine is
816816
@@ -2248,14 +2248,14 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
22482248

22492249

22502250
_SIN_DOCSTRING = """
2251-
Computes sine for each element `x_i` of input array `x`.
2251+
Computes the sine for each element :math:`x_i` of input array `x`.
22522252
22532253
For full documentation refer to :obj:`numpy.sin`.
22542254
22552255
Parameters
22562256
----------
22572257
x : {dpnp.ndarray, usm_ndarray}
2258-
Input array, expected to have numeric data type.
2258+
Input array, expected to have a floating-point data type.
22592259
out : {None, dpnp.ndarray, usm_ndarray}, optional
22602260
Output array to populate.
22612261
Array must have the correct shape and the expected data type.
@@ -2269,8 +2269,8 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
22692269
Returns
22702270
-------
22712271
out : dpnp.ndarray
2272-
An array containing the element-wise sine. The data type of the
2273-
returned array is determined by the Type Promotion Rules.
2272+
An array containing the element-wise sine. The data type of the returned
2273+
array is determined by the Type Promotion Rules.
22742274
22752275
Limitations
22762276
-----------
@@ -2280,7 +2280,7 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
22802280
22812281
See Also
22822282
--------
2283-
:obj:`dpnp.arcsin` : Trigonometric inverse sine, element-wise.
2283+
:obj:`dpnp.asin` : Trigonometric inverse sine, element-wise.
22842284
:obj:`dpnp.cos` : Trigonometric cosine, element-wise.
22852285
:obj:`dpnp.tan` : Trigonometric tangent, element-wise.
22862286
:obj:`dpnp.sinh` : Hyperbolic sine, element-wise.
@@ -2304,15 +2304,19 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
23042304
)
23052305

23062306

2307-
_SINH_DOCSTRING = """
2308-
Computes hyperbolic sine for each element `x_i` for input array `x`.
2307+
_SINH_DOCSTRING = r"""
2308+
Computes the hyperbolic sine for each element :math:`x_i` for input array `x`.
2309+
2310+
The mathematical definition of the hyperbolic sine is
2311+
2312+
.. math:: \operatorname{sinh}(x) = \frac{e^x - e^{-x}}{2}
23092313
23102314
For full documentation refer to :obj:`numpy.sinh`.
23112315
23122316
Parameters
23132317
----------
23142318
x : {dpnp.ndarray, usm_ndarray}
2315-
Input array, expected to have numeric data type.
2319+
Input array, expected to have a floating-point data type.
23162320
out : {None, dpnp.ndarray, usm_ndarray}, optional
23172321
Output array to populate.
23182322
Array must have the correct shape and the expected data type.
@@ -2326,8 +2330,8 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
23262330
Returns
23272331
-------
23282332
out : dpnp.ndarray
2329-
An array containing the element-wise hyperbolic sine. The data type
2330-
of the returned array is determined by the Type Promotion Rules.
2333+
An array containing the element-wise hyperbolic sine. The data type of the
2334+
returned array is determined by the Type Promotion Rules.
23312335
23322336
Limitations
23332337
-----------
@@ -2337,7 +2341,7 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
23372341
23382342
See Also
23392343
--------
2340-
:obj:`dpnp.arcsinh` : Hyperbolic inverse sine, element-wise.
2344+
:obj:`dpnp.asinh` : Hyperbolic inverse sine, element-wise.
23412345
:obj:`dpnp.cosh` : Hyperbolic cosine, element-wise.
23422346
:obj:`dpnp.tanh` : Hyperbolic tangent, element-wise.
23432347
:obj:`dpnp.sin` : Trigonometric sine, element-wise.

0 commit comments

Comments
 (0)