Skip to content

DOC: Update the usage of rtol and atol arguments #59434

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 2 commits into from
Aug 8, 2024
Merged

DOC: Update the usage of rtol and atol arguments #59434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ebd19f
docs: Enhance the usage of rtol and atol arguments in pd.testing.asse…
tan-i-ham Aug 7, 2024
fa64091
pr: Fix review
tan-i-ham Aug 8, 2024
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
5 changes: 4 additions & 1 deletion pandas/_testing/asserters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,7 +1158,10 @@ def assert_frame_equal(
Specify how to compare internal data. If False, compare by columns.
If True, compare by blocks.
check_exact : bool, default False
Whether to compare number exactly.
Whether to compare number exactly. If False, the comparison uses the
relative tolerance (``rtol``) and absolute tolerance (``atol``)
parameters to determine if two values are considered close,
according to the formula: ``|a - b| <= (atol + rtol * |b|)``.

.. versionchanged:: 2.2.0

Expand Down