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.

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

Conversation

tan-i-ham
Copy link
Contributor

@tan-i-ham tan-i-ham commented Aug 7, 2024

Update the usage of rtol and atol arguments in pd.testing.assert_frame_equal

@tan-i-ham tan-i-ham changed the title docs: Enhance the usage of rtol and atol arguments DOC: Enhance the usage of rtol and atol arguments Aug 7, 2024
@tan-i-ham tan-i-ham changed the title DOC: Enhance the usage of rtol and atol arguments DOC: Update the usage of rtol and atol arguments Aug 7, 2024
Comment on lines 1162 to 1164
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|)`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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|)`.
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|)``.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Matthew, I've changed the docs following your code suggestion.

@mroeschke mroeschke added the Docs label Aug 7, 2024
@tan-i-ham tan-i-ham requested a review from mroeschke August 8, 2024 00:11
@mroeschke mroeschke added this to the 3.0 milestone Aug 8, 2024
@mroeschke mroeschke merged commit 7147203 into pandas-dev:main Aug 8, 2024
45 checks passed
@mroeschke
Copy link
Member

Thanks @tan-i-ham

@tan-i-ham tan-i-ham deleted the docs/enhance-assert_frame_equal-usage branch August 10, 2024 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Make usage of rtol and atol arguments in pd.testing.assert_frame_equal clearer
2 participants