Skip to content

Commit 3ebd19f

Browse files
committed
docs: Enhance the usage of rtol and atol arguments in pd.testing.assert_frame_equal
1 parent aa134bb commit 3ebd19f

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

pandas/_testing/asserters.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1158,7 +1158,10 @@ def assert_frame_equal(
11581158
Specify how to compare internal data. If False, compare by columns.
11591159
If True, compare by blocks.
11601160
check_exact : bool, default False
1161-
Whether to compare number exactly.
1161+
Whether to compare number exactly. If False, the comparison uses the
1162+
relative tolerance (`rtol`) and absolute tolerance (`atol`)
1163+
parameters to determine if two values are considered close,
1164+
according to the formula: `|a - b| <= (atol + rtol * |b|)`.
11621165
11631166
.. versionchanged:: 2.2.0
11641167

0 commit comments

Comments
 (0)