Skip to content

Improve documentation for assert_frame|series_equal #26101

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

Closed
qris opened this issue Apr 15, 2019 · 2 comments · Fixed by #26106
Closed

Improve documentation for assert_frame|series_equal #26101

qris opened this issue Apr 15, 2019 · 2 comments · Fixed by #26106
Labels
Milestone

Comments

@qris
Copy link

qris commented Apr 15, 2019

#21528 improved the documentation for assert_almost_equal, but this is actually an undocumented function (not listed in the Pandas docs) and the same issue seems to apply to both assert_series_equal and assert_frame_equal, which are documented.

Could we apply the same change as #21580 to those methods too, i.e. add the following text:

When comparing two numbers, if the first number has magnitude less than 1e-5, we compare the two numbers directly and check whether they are equivalent within the specified precision. Otherwise, we compare the ratio of the second number to the first number and check whether it is equivalent to 1 within the specified precision.

@WillAyd
Copy link
Member

WillAyd commented Apr 15, 2019

Makes sense - a PR from you would certainly be welcome

@WillAyd WillAyd added the Docs label Apr 15, 2019
@sandepp123
Copy link
Contributor

I want to work on this, as it looks like it is good for first timer.

sandepp123 pushed a commit to sandepp123/pandas that referenced this issue Apr 16, 2019
sandepp123 pushed a commit to sandepp123/pandas that referenced this issue Apr 16, 2019
@jreback jreback added this to the 0.25.0 milestone Apr 16, 2019
sandepp123 pushed a commit to sandepp123/pandas that referenced this issue Apr 21, 2019
sandepp123 pushed a commit to sandepp123/pandas that referenced this issue Apr 21, 2019
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 a pull request may close this issue.

4 participants