Skip to content

Update docstrings for logic functions #2368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 17, 2025
Merged

Update docstrings for logic functions #2368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
80111be
Align `keepdims` docstring (state ``None`` value)
antonwolfy Mar 6, 2025
63e945a
Align `out` docstring (state ``None`` value)
antonwolfy Mar 7, 2025
a48964e
Align import alias with ones used in other files
antonwolfy Mar 7, 2025
8018fd4
Add blank lines prior Default value and update
antonwolfy Mar 7, 2025
fec8bc0
Align `order` docstring (state ``None`` value)
antonwolfy Mar 7, 2025
9b1ccc7
Fix typo in out docstring
antonwolfy Mar 7, 2025
cf22580
Merge branch 'master' into update-logic-docstrings
antonwolfy Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dpnp/dpnp_array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,7 +926,7 @@ def copy(self, order="C", device=None, usm_type=None, sycl_queue=None):

Parameters
----------
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array.
Default: ``"C"``.
device : {None, string, SyclDevice, SyclQueue, Device}, optional
Expand Down
4 changes: 2 additions & 2 deletions dpnp/dpnp_iface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ def get_result_array(a, out=None, casting="safe"):
----------
a : {dpnp.ndarray, usm_ndarray}
Input array.
out : {dpnp.ndarray, usm_ndarray}
out : {None, dpnp.ndarray, usm_ndarray}
If provided, value of `a` array will be copied into it
according to ``safe`` casting rule.
It should be of the appropriate shape.
Expand All @@ -585,7 +585,7 @@ def get_result_array(a, out=None, casting="safe"):

Returns
-------
out : {dpnp_array}
out : dpnp.ndarray
Return `out` if provided, otherwise return `a`.

"""
Expand Down
6 changes: 3 additions & 3 deletions dpnp/dpnp_iface_arraycreation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ def array(
(``dtype``, ``order``, etc.). For ``False`` it raises a ``ValueError``
exception if a copy can not be avoided.
Default: ``True``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array.
Default: ``"K"``.
ndmin : int, optional
Expand Down Expand Up @@ -998,7 +998,7 @@ def copy(
Input data, in any form that can be converted to an array. This
includes scalars, lists, lists of tuples, tuples, tuples of tuples,
tuples of lists, and ndarrays.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array.
Default: ``"K"``.
device : {None, string, SyclDevice, SyclQueue, Device}, optional
Expand Down Expand Up @@ -3559,7 +3559,7 @@ def trace(a, offset=0, axis1=0, axis2=1, dtype=None, out=None):
precision, then the default integer precision is used. Otherwise, the
precision is the same as that of `a`.
Default: ``None``.
out : {dpnp.ndarray, usm_ndarray}, optional
out : {None, dpnp.ndarray, usm_ndarray}, optional
Array into which the output is placed. Its type is preserved and it
must be of the right shape to hold the output.
Default: ``None``.
Expand Down
14 changes: 7 additions & 7 deletions dpnp/dpnp_iface_bitwise.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ def binary_repr(num, width=None):
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -231,7 +231,7 @@ def binary_repr(num, width=None):
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -292,7 +292,7 @@ def binary_repr(num, width=None):
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -372,7 +372,7 @@ def binary_repr(num, width=None):
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -450,7 +450,7 @@ def binary_repr(num, width=None):
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -538,7 +538,7 @@ def binary_repr(num, width=None):
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -617,7 +617,7 @@ def binary_repr(num, width=None):
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down
8 changes: 4 additions & 4 deletions dpnp/dpnp_iface_linearalgebra.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -780,7 +780,7 @@ def matmul(
Controls what kind of data casting may occur.

Default: ``"same_kind"``.
order : {"C", "F", "A", "K", None}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -960,7 +960,7 @@ def matvec(
Controls what kind of data casting may occur.

Default: ``"same_kind"``.
order : {"C", "F", "A", "K", None}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -1335,7 +1335,7 @@ def vecdot(
Controls what kind of data casting may occur.

Default: ``"same_kind"``.
order : {"C", "F", "A", "K", None}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down Expand Up @@ -1463,7 +1463,7 @@ def vecmat(
Controls what kind of data casting may occur.

Default: ``"same_kind"``.
order : {"C", "F", "A", "K", None}, optional
order : {None, "C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Expand Down
Loading
Loading