Skip to content

Commit 10ce7b6

Browse files
Add Warning section to maximum/minimum docs
1 parent 83ace79 commit 10ce7b6

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

dpnp/dpnp_iface_mathematical.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3204,6 +3204,14 @@ def interp(x, xp, fp, left=None, right=None, period=None):
32043204
32053205
Default: ``"K"``.
32063206
3207+
Warning
3208+
-------
3209+
Passing the output array ``out`` positionally is deprecated.
3210+
For example, ``dpnp.maximum(a, b, c)`` will emit a ``DeprecationWarning``.
3211+
3212+
Always pass the output with the keyword form, e.g.
3213+
``dpnp.maximum(a, b, out=c)``.
3214+
32073215
Returns
32083216
-------
32093217
out : dpnp.ndarray
@@ -3316,6 +3324,14 @@ def maximum(*args, **kwargs):
33163324
An array containing the element-wise minima. The data type of
33173325
the returned array is determined by the Type Promotion Rules.
33183326
3327+
Warning
3328+
-------
3329+
Passing the output array ``out`` positionally is deprecated.
3330+
For example, ``dpnp.minimum(a, b, c)`` will emit a ``DeprecationWarning``.
3331+
3332+
Always pass the output with the keyword form, e.g.
3333+
``dpnp.minimum(a, b, out=c)``.
3334+
33193335
Limitations
33203336
-----------
33213337
Parameters `where` and `subok` are supported with their default values.

0 commit comments

Comments
 (0)