Skip to content

Correct assert_frame_equal doc string #22552

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 7 commits into from
Sep 3, 2018
Merged

Correct assert_frame_equal doc string #22552

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b8a7530
Correct assert_frame_equal doc string
pablojim Aug 31, 2018
234cb53
DOC: correct assert_frame_equal docstring
pablojim Aug 31, 2018
62f29a0
DOC: update assert_frame_equal docstring
pablojim Aug 31, 2018
0f8cb08
DOC: update assert_frame_equal docstring updates
pablojim Sep 2, 2018
0019855
DOC: update assert_frame_equal, fix line length
pablojim Sep 2, 2018
3c532ce
DOC: update assert_frame_equal equiv formatting
pablojim Sep 3, 2018
6a861d7
DOC: update assert_frame_equal equiv further updates
pablojim Sep 3, 2018
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
Prev Previous commit
Next Next commit
DOC: update assert_frame_equal, fix line length
  • Loading branch information
@pablojim
pablojim committed Sep 2, 2018
commit 00198554d9688743e1b9645d17946003cd5e08ae
2 changes: 1 addition & 1 deletion pandas/util/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,7 @@ def assert_frame_equal(left, right, check_dtype=True,

See Also
--------
assert_series_equal: equivalent method to this for asserting Series equality
assert_series_equal: equivalent method for asserting Series equality
DataFrame.equals: check DataFrame equality
Copy link
Member

Choose a reason for hiding this comment

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

Do you think it makes sense adding a example?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure an example is particularly useful in this case.

Copy link
Member

Choose a reason for hiding this comment

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

We've got users of all levels, and things like comparing dataframes with different types are worth showing with examples.

Besides that, can you add a space before the colons in the see also section, capitalize the first letter of the description, and finish the description with a period? If you generate the html ./doc/make.py html --single pandas.util.testing.assert_frame_equal, I don't think without the space this is being rendered correcty.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added examples and corrected formatting as mentioned.

"""

Expand Down