Skip to content

Commit 8a27ab9

Browse files
committed
Update the docstrings of erf functions, because they are also ufuncs
1 parent ae86169 commit 8a27ab9

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

dpnp/scipy/special/_erf.py

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def __init__(
6969
mkl_impl_fn=mkl_impl_fn,
7070
)
7171

72-
def __call__(self, x, out=None): # pylint: disable=signature-differs
72+
def __call__(self, x, /, out=None):
7373
return super().__call__(x, out=out)
7474

7575

@@ -84,8 +84,12 @@ def __call__(self, x, out=None): # pylint: disable=signature-differs
8484
----------
8585
x : {dpnp.ndarray, usm_ndarray}
8686
Input array, expected to have a real-valued floating-point data type.
87-
out : {dpnp.ndarray, usm_ndarray}, optional
87+
out : {None, dpnp.ndarray, usm_ndarray, tuple of ndarray}, optional
8888
Optional output array for the function values.
89+
A tuple (possible only as a keyword argument) must have length equal to the
90+
number of outputs.
91+
92+
Default: ``None``.
8993
9094
Returns
9195
-------
@@ -140,8 +144,12 @@ def __call__(self, x, out=None): # pylint: disable=signature-differs
140144
----------
141145
x : {dpnp.ndarray, usm_ndarray}
142146
Input array, expected to have a real-valued floating-point data type.
143-
out : {dpnp.ndarray, usm_ndarray}, optional
147+
out : {None, dpnp.ndarray, usm_ndarray, tuple of ndarray}, optional
144148
Optional output array for the function values.
149+
A tuple (possible only as a keyword argument) must have length equal to the
150+
number of outputs.
151+
152+
Default: ``None``.
145153
146154
Returns
147155
-------
@@ -185,8 +193,12 @@ def __call__(self, x, out=None): # pylint: disable=signature-differs
185193
----------
186194
x : {dpnp.ndarray, usm_ndarray}
187195
Input array, expected to have a real-valued floating-point data type.
188-
out : {dpnp.ndarray, usm_ndarray}, optional
196+
out : {None, dpnp.ndarray, usm_ndarray, tuple of ndarray}, optional
189197
Optional output array for the function values.
198+
A tuple (possible only as a keyword argument) must have length equal to the
199+
number of outputs.
200+
201+
Default: ``None``..
190202
191203
Returns
192204
-------
@@ -231,8 +243,12 @@ def __call__(self, x, out=None): # pylint: disable=signature-differs
231243
x : {dpnp.ndarray, usm_ndarray}
232244
Input array, expected to have a real-valued floating-point data type.
233245
Domain: [-1, 1].
234-
out : {dpnp.ndarray, usm_ndarray}, optional
246+
out : {None, dpnp.ndarray, usm_ndarray, tuple of ndarray}, optional
235247
Optional output array for the function values.
248+
A tuple (possible only as a keyword argument) must have length equal to the
249+
number of outputs.
250+
251+
Default: ``None``.
236252
237253
Returns
238254
-------
@@ -284,8 +300,12 @@ def __call__(self, x, out=None): # pylint: disable=signature-differs
284300
x : {dpnp.ndarray, usm_ndarray}
285301
Input array, expected to have a real-valued floating-point data type.
286302
Domain: [0, 2].
287-
out : {dpnp.ndarray, usm_ndarray}, optional
303+
out : {None, dpnp.ndarray, usm_ndarray, tuple of ndarray}, optional
288304
Optional output array for the function values.
305+
A tuple (possible only as a keyword argument) must have length equal to the
306+
number of outputs.
307+
308+
Default: ``None``.
289309
290310
Returns
291311
-------

0 commit comments

Comments
 (0)