Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit ebbf98c

Browse files
committedJan 20, 2025·
Notes on testing
1 parent 1fe521a commit ebbf98c

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed
 

‎src/array_api_extra/_lib/_testing.py

+15
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ def xp_assert_equal(actual: Array, desired: Array, err_msg: str = "") -> None:
6161
The expected array (typically hardcoded).
6262
err_msg : str, optional
6363
Error message to display on failure.
64+
65+
See Also
66+
--------
67+
xp_assert_close
68+
np.testing.assert_array_equal
6469
"""
6570
xp = _check_ns_shape_dtype(actual, desired)
6671

@@ -112,6 +117,16 @@ def xp_assert_close(
112117
Absolute tolerance. Default: 0.
113118
err_msg : str, optional
114119
Error message to display on failure.
120+
121+
See Also
122+
--------
123+
xp_assert_equal
124+
allclose
125+
numpy.testing.assert_allclose
126+
127+
Notes
128+
-----
129+
The default `atol` and `rtol` differ from `xpx.allclose`.
115130
"""
116131
xp = _check_ns_shape_dtype(actual, desired)
117132

0 commit comments

Comments
 (0)
Please sign in to comment.