Updated docstring of impacted functions

IntelPython · Apr 4, 2024 · 76e9d3d · 76e9d3d
1 parent ea30077
commit 76e9d3d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 63 deletions.
diff --git a/dpnp/dpnp_iface_mathematical.py b/dpnp/dpnp_iface_mathematical.py
@@ -2800,25 +2800,10 @@ def sum(
         If ``None``, the sum is computed over the entire array.
         Default: ``None``.
     dtype : dtype, optional
-        Data type of the returned array. If ``None``, the default data
-        type is inferred from the "kind" of the input array data type.
-            * If `a` has a real-valued floating-point data type,
-              the returned array will have the default real-valued
-              floating-point data type for the device where input
-              array `a` is allocated.
-            * If `a` has signed integral data type, the returned array
-              will have the default signed integral type for the device
-              where input array `a` is allocated.
-            * If `a` has unsigned integral data type, the returned array
-              will have the default unsigned integral type for the device
-              where input array `a` is allocated.
-            * If `a` has a complex-valued floating-point data type,
-              the returned array will have the default complex-valued
-              floating-pointer data type for the device where input
-              array `a` is allocated.
-            * If `a` has a boolean data type, the returned array will
-              have the default signed integral type for the device
-              where input array `a` is allocated.
+        Data type of the returned array. If ``None``, it defaults to the dtype
+        of `a`, unless `a` has an integer dtype with a precision less than that
+        of the default platform integer. In that case, the default platform
+        integer is used.
         If the data type (either specified or resolved) differs from the
         data type of `a`, the input array elements are cast to the
         specified data type before computing the sum.

diff --git a/dpnp/dpnp_iface_nanfunctions.py b/dpnp/dpnp_iface_nanfunctions.py
@@ -714,25 +714,10 @@ def nansum(
         If ``None``, the sum is computed over the entire array.
         Default: ``None``.
     dtype : dtype, optional
-        Data type of the returned array. If ``None``, the default data
-        type is inferred from the "kind" of the input array data type.
-            * If `a` has a real-valued floating-point data type,
-              the returned array will have the default real-valued
-              floating-point data type for the device where input
-              array `a` is allocated.
-            * If `a` has signed integral data type, the returned array
-              will have the default signed integral type for the device
-              where input array `a` is allocated.
-            * If `a` has unsigned integral data type, the returned array
-              will have the default unsigned integral type for the device
-              where input array `a` is allocated.
-            * If `a` has a complex-valued floating-point data type,
-              the returned array will have the default complex-valued
-              floating-pointer data type for the device where input
-              array `a` is allocated.
-            * If `a` has a boolean data type, the returned array will
-              have the default signed integral type for the device
-              where input array `a` is allocated.
+        Data type of the returned array. If ``None``, it defaults to the dtype
+        of `a`, unless `a` has an integer dtype with a precision less than that
+        of the default platform integer. In that case, the default platform
+        integer is used.
         If the data type (either specified or resolved) differs from the
         data type of `a`, the input array elements are cast to the
         specified data type before computing the sum.

diff --git a/dpnp/dpnp_iface_trigonometric.py b/dpnp/dpnp_iface_trigonometric.py
@@ -1352,17 +1352,10 @@ def logsumexp(x, axis=None, out=None, dtype=None, keepdims=False):
         If provided, the result will be inserted into this array. It should
         be of the appropriate shape and dtype.
     dtype : data type, optional
-        Data type of the returned array. If ``None``, the default data
-        type is inferred from the "kind" of the input array data type.
-            * If `x` has a real-valued floating-point data type,
-              the returned array will have the default real-valued
-              floating-point data type for the device where input
-              array `x` is allocated.
-            * If `x` has a boolean or integral data type, the returned array
-              will have the default floating point data type for the device
-              where input array `x` is allocated.
-            * If `x` has a complex-valued floating-point data type,
-              an error is raised.
+        Data type of the returned array. If ``None``, it defaults to the dtype
+        of `a`, unless `a` has an integer dtype with a precision less than that
+        of the default platform integer. In that case, the default platform
+        integer is used.
         If the data type (either specified or resolved) differs from the
         data type of `x`, the input array elements are cast to the
         specified data type before computing the result. Default: ``None``.
@@ -1498,20 +1491,14 @@ def reduce_hypot(x, axis=None, out=None, dtype=None, keepdims=False):
         If provided, the result will be inserted into this array. It should
         be of the appropriate shape and dtype.
     dtype : data type, optional
-            Data type of the returned array. If ``None``, the default data
-            type is inferred from the "kind" of the input array data type.
-                * If `x` has a real-valued floating-point data type,
-                  the returned array will have the default real-valued
-                  floating-point data type for the device where input
-                  array `x` is allocated.
-                * If `x` has a boolean or integral data type, the returned array
-                  will have the default floating point data type for the device
-                  where input array `x` is allocated.
-                * If `x` has a complex-valued floating-point data type,
-                  an error is raised.
-            If the data type (either specified or resolved) differs from the
-            data type of `x`, the input array elements are cast to the
-            specified data type before computing the result. Default: ``None``.
+        Data type of the returned array. If ``None``, it defaults to the dtype
+        of `a`, unless `a` has an integer dtype with a precision less than that
+        of the default platform integer. In that case, the default platform
+        integer is used.
+        If the data type (either specified or resolved) differs from the
+        data type of `x`, the input array elements are cast to the
+        specified data type before computing the result.
+        Default: ``None``.
     keepdims : bool
         If ``True``, the reduced axes (dimensions) are included in the result
         as singleton dimensions, so that the returned array remains