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.

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

Conversation

DeanLa
Copy link
Contributor

@DeanLa DeanLa commented Jul 28, 2018

@@ -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
Member

Choose a reason for hiding this comment

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

Can you capitalize True?

@codecov
Copy link

codecov bot commented Jul 29, 2018

Codecov Report

Merging #22106 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #22106      +/-   ##
==========================================
+ Coverage   92.06%   92.07%   +0.01%     
==========================================
  Files         170      170              
  Lines       50705    50688      -17     
==========================================
- Hits        46680    46671       -9     
+ Misses       4025     4017       -8
Flag Coverage Δ
#multiple 90.48% <ø> (+0.01%) ⬆️
#single 42.31% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/util/testing.py 85.9% <ø> (+0.21%) ⬆️
pandas/core/tools/datetimes.py 85.07% <0%> (-0.15%) ⬇️
pandas/io/sas/sas_xport.py 90.23% <0%> (-0.05%) ⬇️
pandas/io/formats/html.py 88.81% <0%> (-0.04%) ⬇️
pandas/core/indexing.py 93.79% <0%> (-0.03%) ⬇️
pandas/core/groupby/generic.py 86.79% <0%> (-0.02%) ⬇️
pandas/core/sparse/frame.py 94.78% <0%> (-0.02%) ⬇️
pandas/core/indexes/interval.py 94.11% <0%> (-0.02%) ⬇️
pandas/core/dtypes/dtypes.py 96.03% <0%> (-0.02%) ⬇️
pandas/core/internals/blocks.py 94.45% <0%> (-0.02%) ⬇️
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b7a08b...a3abbd7. Read the comment docs.

@@ -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

@jreback jreback added Testing pandas testing functions or related to the test suite Docs labels Jul 29, 2018
@DeanLa
Copy link
Contributor Author

DeanLa commented Jul 30, 2018

Changed as requested

@@ -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 index & columns.
Note: row labels must match their respective rows
Copy link
Member

Choose a reason for hiding this comment

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

Use index instead of row

@jreback jreback added this to the 0.24.0 milestone Jul 31, 2018
@jreback
Copy link
Contributor

jreback commented Jul 31, 2018

lgtm. @WillAyd merge when satisfied.

@WillAyd WillAyd merged commit 20f7ae8 into pandas-dev:master Jul 31, 2018
@WillAyd
Copy link
Member

WillAyd commented Jul 31, 2018

Thanks @DeanLa !

@DeanLa DeanLa deleted the assert-frames-equal-doc-22052 branch July 31, 2018 18:24
dberenbaum pushed a commit to dberenbaum/pandas that referenced this pull request Aug 3, 2018
Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Testing pandas testing functions or related to the test suite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pd.testing.assert_frame_equal check_like not working like expected
3 participants