Skip to content

Commit 6fd134f

Browse files
committed
Add description of out keyword
1 parent a496341 commit 6fd134f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

dpnp/dpnp_iface_mathematical.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2366,6 +2366,15 @@ def ediff1d(ary, to_end=None, to_begin=None):
23662366
as `x` and the expected data type.
23672367
23682368
Default: ``None``.
2369+
2370+
out : tuple of None, dpnp.ndarray, or usm_ndarray, optional
2371+
A location into which the result is stored. If provided, it must be a tuple
2372+
and have length equal to the number of outputs. Each provided array must
2373+
have the same shape as `x` and the expected data type.
2374+
It is prohibited to pass output arrays through `out` keyword when either
2375+
`out1` or `out2` is passed.
2376+
2377+
Default: ``(None, None)``.
23692378
order : {None, "C", "F", "A", "K"}, optional
23702379
Memory layout of the newly output array, if parameter `out` is ``None``.
23712380
@@ -2380,7 +2389,7 @@ def ediff1d(ary, to_end=None, to_begin=None):
23802389
23812390
Limitations
23822391
-----------
2383-
Parameters `where` and `subok` are supported with their default values.
2392+
Parameters `where`, `dtype` and `subok` are supported with their default values.
23842393
Keyword argument `kwargs` is currently unsupported.
23852394
Otherwise ``NotImplementedError`` exception will be raised.
23862395

0 commit comments

Comments
 (0)