Skip to content

Commit 7147203

Browse files
authored
DOC: Update the usage of rtol and atol arguments (#59434)
* docs: Enhance the usage of rtol and atol arguments in pd.testing.assert_frame_equal * pr: Fix review
1 parent 3754267 commit 7147203

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

pandas/_testing/asserters.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -1176,7 +1176,10 @@ def assert_frame_equal(
11761176
Specify how to compare internal data. If False, compare by columns.
11771177
If True, compare by blocks.
11781178
check_exact : bool, default False
1179-
Whether to compare number exactly.
1179+
Whether to compare number exactly. If False, the comparison uses the
1180+
relative tolerance (``rtol``) and absolute tolerance (``atol``)
1181+
parameters to determine if two values are considered close,
1182+
according to the formula: ``|a - b| <= (atol + rtol * |b|)``.
11801183
11811184
.. versionchanged:: 2.2.0
11821185

0 commit comments

Comments
 (0)