Apply review comments

Author: antonwolfy

dpnp/dpnp_iface_linearalgebra.py

@@ -617,7 +617,7 @@ def inner(a, b):
 
     See Also
     --------
-    :obj:`dpnp.einsum` : Einstein summation convention..
+    :obj:`dpnp.einsum` : Einstein summation convention.
     :obj:`dpnp.dot` : Generalized matrix product,
                       using second last dimension of `b`.
     :obj:`dpnp.tensordot` : Sum products over arbitrary axes.
@@ -998,7 +998,7 @@ def matvec(
 
     See Also
     --------
-    :obj:`dpnp.vecdot` : Vector-vector product..
+    :obj:`dpnp.vecdot` : Vector-vector product.
     :obj:`dpnp.vecmat` : Vector-matrix product.
     :obj:`dpnp.matmul` : Matrix-matrix product.
     :obj:`dpnp.einsum` : Einstein summation convention.
@@ -1502,7 +1502,7 @@ def vecmat(
 
     See Also
     --------
-    :obj:`dpnp.vecdot` : Vector-vector product..
+    :obj:`dpnp.vecdot` : Vector-vector product.
     :obj:`dpnp.matvec` : Matrix-vector product.
     :obj:`dpnp.matmul` : Matrix-matrix product.
     :obj:`dpnp.einsum` : Einstein summation convention.

dpnp/dpnp_iface_logic.py

@@ -985,7 +985,7 @@ def iscomplexobj(x):
 
 
 _ISFINITE_DOCSTRING = """
-Test each element :math:`x_i` of input array `x` if finite.
+Test each element :math:`x_i` of the input array `x` to determine if finite.
 
 For full documentation refer to :obj:`numpy.isfinite`.
 

dpnp/dpnp_iface_mathematical.py

@@ -351,7 +351,7 @@ def _process_ediff1d_args(arg, arg_name, ary_dtype, ary_sycl_queue, usm_type):
 _ABS_DOCSTRING = """
 Calculates the absolute value for each element :math:`x_i` of input array `x`.
 
-For full documentation refer to :obj:`numpy.abs`.
+For full documentation refer to :obj:`numpy.absolute`.
 
 Parameters
 ----------
@@ -372,8 +372,8 @@ def _process_ediff1d_args(arg, arg_name, ary_dtype, ary_sycl_queue, usm_type):
 out : dpnp.ndarray
     An array containing the element-wise absolute values.
     For complex input, the absolute value is its magnitude.
-    If `x` has a real-valued floating-point data type, the returned array has
-    the same data type as `x`. If `x` has a complex floating-point data type,
+    If `x` has a real-valued data type, the returned array has the
+    same data type as `x`. If `x` has a complex floating-point data type,
     the returned array has a real-valued floating-point data type whose
     precision matches the precision of `x`.
 
@@ -389,7 +389,7 @@ def _process_ediff1d_args(arg, arg_name, ary_dtype, ary_sycl_queue, usm_type):
 
 Notes
 -----
-``dpnp.absolute`` is a shorthand for this function.
+``dpnp.absolute`` is an equivalent function.
 
 Examples
 --------
@@ -497,7 +497,7 @@ def _process_ediff1d_args(arg, arg_name, ary_dtype, ary_sycl_queue, usm_type):
 )
 
 
-_ANGLE_DOCSTRING = """
+_ANGLE_DOCSTRING = r"""
 Computes the phase angle (also called the argument) of each element :math:`x_i`
 for input array `x`.
 
@@ -530,13 +530,13 @@ def _process_ediff1d_args(arg, arg_name, ary_dtype, ary_sycl_queue, usm_type):
 
 Notes
 -----
-Although the angle of the complex number 0 is undefined, `dpnp.angle(0)` returns
-the value ``0``.
+Although the angle of the complex number ``0`` is undefined, ``dpnp.angle(0)``
+returns the value ``0``.
 
 See Also
 --------
-:obj:`dpnp.atan2` : Element-wise arc tangent of `x1/x2` choosing the quadrant
-    correctly.
+:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}/{x2}` choosing
+    the quadrant correctly.
 :obj:`dpnp.atan` : Trigonometric inverse tangent, element-wise.
 :obj:`dpnp.abs` : Calculate the absolute value element-wise.
 :obj:`dpnp.real` : Return the real part of the complex argument.
@@ -2703,7 +2703,7 @@ def gradient(f, *varargs, axis=None, edge_order=1):
 -------
 out : dpnp.ndarray
     An array containing the element-wise imaginary component of input.
-    If the input is a real-valued floating-point data type, the returned array has
+    If the input is a real-valued data type, the returned array has
     the same data type. If the input is a complex floating-point
     data type, the returned array has a floating-point data type
     with the same floating-point precision as complex input.
@@ -3764,7 +3764,7 @@ def prod(
 Parameters
 ----------
 x : {dpnp.ndarray, usm_ndarray}
-    Input array, expected to have a numeric data type.
+    Input array, may have any data type.
 out : {None, dpnp.ndarray, usm_ndarray}, optional
     Output array to populate.
     Array must have the correct shape and the expected data type.
@@ -3779,7 +3779,7 @@ def prod(
 -------
 out : dpnp.ndarray
     An array containing the element-wise real component of input.
-    If the input is a real-valued floating-point data type, the returned array has
+    If the input is a real-valued data type, the returned array has
     the same data type. If the input is a complex floating-point
     data type, the returned array has a floating-point data type
     with the same floating-point precision as complex input.
@@ -4105,7 +4105,7 @@ def real_if_close(a, tol=100):
     \frac{x_i}{|x_i|} & \textrm{otherwise}
     \end{cases}
 
-    where :math:`|x_i|` is the absolute value of :math:`x_i`.
+where :math:`|x_i|` is the absolute value of :math:`x_i`.
 
 For full documentation refer to :obj:`numpy.sign`.
 
@@ -4166,8 +4166,8 @@ def real_if_close(a, tol=100):
 input array `x`.
 
 The sign bit of a real-valued floating-point number :math:`x_i` is set whenever
-:math:`x_i` is either ``-0``, less than zero, or a signed ``NaN`` (i.e., a NaN
-value whose sign bit is ``1``).
+:math:`x_i` is either ``-0``, less than zero, or a signed ``NaN``
+(i.e., a ``NaN`` value whose sign bit is ``1``).
 
 For full documentation refer to :obj:`numpy.signbit`.
 

dpnp/dpnp_iface_trigonometric.py

@@ -315,7 +315,7 @@ def _get_accumulation_res_dt(a, dtype):
 :obj:`dpnp.acos` : Trigonometric inverse cosine, element-wise.
 :obj:`dpnp.tan` : Trigonometric tangent, element-wise.
 :obj:`dpnp.atan` : Trigonometric inverse tangent, element-wise.
-:obj:`dpnp.atan2` : Element-wise arc tangent of `x1/x2`
+:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}/{x2}`
     choosing the quadrant correctly.
 :obj:`dpnp.asinh` : Hyperbolic inverse sine, element-wise.
 
@@ -477,7 +477,7 @@ def _get_accumulation_res_dt(a, dtype):
 
 See Also
 --------
-:obj:`dpnp.atan2` : Element-wise arc tangent of `x1/x2`
+:obj:`dpnp.atan2` : Element-wise arc tangent of :math:`\frac{x1}/{x2}`
     choosing the quadrant correctly.
 :obj:`dpnp.angle` : Argument of complex values.
 :obj:`dpnp.tan` : Trigonometric tangent, element-wise.
@@ -554,9 +554,9 @@ def _get_accumulation_res_dt(a, dtype):
 Returns
 -------
 out : dpnp.ndarray
-    An array containing the inverse tangent of the quotient :math:`x1/x2`, in
-    radians. The returned array must have a real-valued floating-point data
-    type determined by Type Promotion Rules.
+    An array containing the inverse tangent of the quotient
+    :math:`\frac{x1}/{x2}`, in radians. The returned array must have a
+    real-valued floating-point data type determined by Type Promotion Rules.
 
 Limitations
 -----------
@@ -1027,7 +1027,7 @@ def cumlogsumexp(
 
 
 _DEGREES_DOCSTRING = r"""
-Convert angles from degrees to radians for each element :math:`x_i` for input
+Convert angles from radian to degrees for each element :math:`x_i` for input
 array `x`.
 
 For full documentation refer to :obj:`numpy.degrees`.
@@ -1210,8 +1210,8 @@ def cumlogsumexp(
 
 
 _EXPM1_DOCSTRING = r"""
-Computes the exponential minus 1 for each element :math:`x_i` of input array
-`x`.
+Computes the exponential minus ``1`` for each element :math:`x_i` of input
+array `x`.
 
 For full documentation refer to :obj:`numpy.expm1`.
 
@@ -1918,7 +1918,7 @@ def logsumexp(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
 
 
 _RAD2DEG_DOCSTRING = r"""
-Convert angles from degrees to radians for each element :math:`x_i` for input
+Convert angles from radians to degrees for each element :math:`x_i` for input
 array `x`.
 
 For full documentation refer to :obj:`numpy.rad2deg`.
@@ -2472,7 +2472,7 @@ def reduce_hypot(x, /, *, axis=None, dtype=None, keepdims=False, out=None):
 
 See Also
 --------
-:obj:`dpnp..linalg.matrix_power` : Raise a square matrix to the (integer)
+:obj:`dpnp.linalg.matrix_power` : Raise a square matrix to the (integer)
     power `n`.
 :obj:`dpnp.sqrt` : Calculate :math:`\sqrt{x}`, element-wise.
 :obj:`dpnp.power` : Calculate :math:`{x1}^{x2}`, element-wise.