Skip to content

DOC: Clarify check_like behavior in assert_frame_equal #22106

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 4 commits into from
Jul 31, 2018
Merged

DOC: Clarify check_like behavior in assert_frame_equal #22106

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
671d96f
DOC: Clarify check_like behavior in assert_frame_equal GH22052
DeanLa Jul 28, 2018
84a68d1
DOC: Clarify check_like behavior in assert_frame_equal GH22052
DeanLa Jul 29, 2018
c6a6560
DOC: assert_frame_equal index_like wording
DeanLa Jul 29, 2018
a3abbd7
DOC: assert frames equal wording
DeanLa Jul 31, 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
4 changes: 3 additions & 1 deletion pandas/util/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1348,7 +1348,9 @@ def assert_frame_equal(left, right, check_dtype=True,
check_categorical : bool, default True
Whether to compare internal Categorical exactly.
check_like : bool, default False
If true, ignore the order of rows & columns
If True, ignore the order of rows & columns.
Copy link
Contributor

Choose a reason for hiding this comment

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

can you change rows -> index (then don't need the work Index on next line), just use index

Note: Index (row) labels must match their respective rows
(same as in columns) - same labels must be with the same data
obj : str, default 'DataFrame'
Specify object name being compared, internally used to show appropriate
assertion message
Expand Down