Skip to content

Commit bdc0b20

Browse files
Rename check_stacked_2d to assert_stacked_2d
1 parent b9f326a commit bdc0b20

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

dpnp/linalg/dpnp_utils_linalg.py

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
__all__ = [
3838
"assert_2d",
39-
"check_stacked_2d",
39+
"assert_stacked_2d",
4040
"check_stacked_square",
4141
"dpnp_cholesky",
4242
"dpnp_cond",
@@ -710,9 +710,9 @@ def assert_2d(*arrays):
710710
)
711711

712712

713-
def check_stacked_2d(*arrays):
713+
def assert_stacked_2d(*arrays):
714714
"""
715-
Return ``True`` if each array in `arrays` has at least two dimensions.
715+
Check that each array in `arrays` has at least two dimensions.
716716
717717
If any array is less than two-dimensional, `dpnp.linalg.LinAlgError` will be raised.
718718
@@ -721,11 +721,6 @@ def check_stacked_2d(*arrays):
721721
arrays : {dpnp.ndarray, usm_ndarray}
722722
A sequence of input arrays to check for dimensionality.
723723
724-
Returns
725-
-------
726-
out : bool
727-
``True`` if each array in `arrays` is at least two-dimensional.
728-
729724
Raises
730725
------
731726
dpnp.linalg.LinAlgError
@@ -751,7 +746,7 @@ def check_stacked_square(*arrays):
751746
beforehand. For example,
752747
753748
>>> def solve(a):
754-
... check_stacked_2d(a)
749+
... assert_stacked_2d(a)
755750
... check_stacked_square(a)
756751
... ...
757752

0 commit comments

Comments
 (0)