From 359a1d5466dfc2755279920c2d4cd3b4c4e4aa64 Mon Sep 17 00:00:00 2001 From: Anton Volkov Date: Wed, 19 Aug 2026 15:11:51 +0200 Subject: [PATCH] docs: document variadic parameters with leading star Several docstrings documented variadic parameters without the leading `*`/`**`, so the type read like a single value rather than a sequence. Align them with the numpydoc convention (as used by broadcast/broadcast_arrays): - apply_along_axis: `args`/`kwargs` -> `*args`/`**kwargs` - check_supported_arrays_type: `arrays` -> `*arrays` - _compute_res_dtype: `arrays` -> `*arrays` --- dpnp/dpnp_iface.py | 2 +- dpnp/dpnp_iface_functional.py | 4 ++-- dpnp/dpnp_utils/dpnp_utils_linearalgebra.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/dpnp/dpnp_iface.py b/dpnp/dpnp_iface.py index 00f8bf225db6..d36aa06da991 100644 --- a/dpnp/dpnp_iface.py +++ b/dpnp/dpnp_iface.py @@ -261,7 +261,7 @@ def check_supported_arrays_type(*arrays, scalar_type=False, all_scalars=False): Parameters ---------- - arrays : {dpnp.ndarray, usm_ndarray} + *arrays : {dpnp.ndarray, usm_ndarray} Input arrays to check for supported types. scalar_type : bool, optional A scalar type is also considered as supported if flag is ``True``. diff --git a/dpnp/dpnp_iface_functional.py b/dpnp/dpnp_iface_functional.py index 0ed965b0698f..626e996d6ba6 100644 --- a/dpnp/dpnp_iface_functional.py +++ b/dpnp/dpnp_iface_functional.py @@ -88,9 +88,9 @@ def apply_along_axis(func1d, axis, arr, *args, **kwargs): Axis along which `arr` is sliced. arr : {dpnp.ndarray, usm_ndarray} (Ni..., M, Nk...) Input array. - args : any + *args : any Additional arguments to `func1d`. - kwargs : any + **kwargs : any Additional named arguments to `func1d`. Returns diff --git a/dpnp/dpnp_utils/dpnp_utils_linearalgebra.py b/dpnp/dpnp_utils/dpnp_utils_linearalgebra.py index 5955f6bd28ae..9e63a5932abc 100644 --- a/dpnp/dpnp_utils/dpnp_utils_linearalgebra.py +++ b/dpnp/dpnp_utils/dpnp_utils_linearalgebra.py @@ -65,7 +65,7 @@ def _compute_res_dtype(*arrays, dtype=None, out=None, casting="no"): Parameters ---------- - arrays : {dpnp.ndarray, usm_ndarray} + *arrays : {dpnp.ndarray, usm_ndarray} Input arrays. dtype : dtype If not ``None`` and `out` is not defined, data type of the output array.