Skip to content

Commit 0cb520b

Browse files
committed
Update atan2 docstring with proper use of :math:\frac{x1}{x2}
1 parent d0f1b97 commit 0cb520b

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

dpnp/dpnp_iface_mathematical.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ def _process_ediff1d_args(arg, arg_name, ary_dtype, ary_sycl_queue, usm_type):
535535
536536
See Also
537537
--------
538-
:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}/{x2}` choosing
538+
:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}{x2}` choosing
539539
the quadrant correctly.
540540
:obj:`dpnp.atan` : Trigonometric inverse tangent, element-wise.
541541
:obj:`dpnp.abs` : Calculate the absolute value element-wise.

dpnp/dpnp_iface_trigonometric.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ def _get_accumulation_res_dt(a, dtype):
315315
:obj:`dpnp.acos` : Trigonometric inverse cosine, element-wise.
316316
:obj:`dpnp.tan` : Trigonometric tangent, element-wise.
317317
:obj:`dpnp.atan` : Trigonometric inverse tangent, element-wise.
318-
:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}/{x2}`
318+
:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}{x2}`
319319
choosing the quadrant correctly.
320320
:obj:`dpnp.asinh` : Hyperbolic inverse sine, element-wise.
321321
@@ -477,7 +477,7 @@ def _get_accumulation_res_dt(a, dtype):
477477
478478
See Also
479479
--------
480-
:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}/{x2}`
480+
:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}{x2}`
481481
choosing the quadrant correctly.
482482
:obj:`dpnp.angle` : Argument of complex values.
483483
:obj:`dpnp.tan` : Trigonometric tangent, element-wise.
@@ -523,9 +523,9 @@ def _get_accumulation_res_dt(a, dtype):
523523
arctan = atan # arctan is an alias for atan
524524

525525

526-
_ATAN2_DOCSTRING = """
527-
Calculates the inverse tangent of the quotient :math:`x1_i/x2_i` for each
528-
element :math:`x1_i` of the input array `x1` with the respective element
526+
_ATAN2_DOCSTRING = r"""
527+
Calculates the inverse tangent of the quotient :math:`\frac{x1_i}{x2_i}` for
528+
each element :math:`x1_i` of the input array `x1` with the respective element
529529
:math:`x2_i` of the input array `x2`.
530530
531531
Note that :obj:`dpnp.arctan2` is an alias of :obj:`dpnp.atan2`.
@@ -555,7 +555,7 @@ def _get_accumulation_res_dt(a, dtype):
555555
-------
556556
out : dpnp.ndarray
557557
An array containing the inverse tangent of the quotient
558-
:math:`\frac{x1}/{x2}`, in radians. The returned array must have a
558+
:math:`\frac{x1}{x2}`, in radians. The returned array must have a
559559
real-valued floating-point data type determined by Type Promotion Rules.
560560
561561
Limitations

0 commit comments

Comments
 (0)