Skip to content

Clear up confusion from #19411 #19554

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 1 commit into from
Jul 6, 2018
Merged

Conversation

darcymeyer
Copy link
Contributor

@darcymeyer darcymeyer commented Feb 6, 2018

Modify docstring for pandas.util.testing.assert_frame_equal
closes #19411

@codecov
Copy link

codecov bot commented Feb 6, 2018

Codecov Report

Merging #19554 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #19554   +/-   ##
=======================================
  Coverage   91.93%   91.93%           
=======================================
  Files         159      159           
  Lines       49733    49733           
=======================================
  Hits        45721    45721           
  Misses       4012     4012
Flag Coverage Δ
#multiple 90.31% <ø> (ø) ⬆️
#single 42% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/util/testing.py 85.33% <ø> (ø) ⬆️

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 d24a950...32191bb. Read the comment docs.

@@ -1215,6 +1215,10 @@ def assert_frame_equal(left, right, check_dtype=True,
obj='DataFrame'):
"""Check that left and right DataFrame are equal.

Each element at [row, column] in left is compared to the
element at [row, column] in right (index and column values
Copy link
Contributor

Choose a reason for hiding this comment

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

this last part of the comment adds to confusion. can you clarify. Maybe add this to a Notes section

Copy link
Member

Choose a reason for hiding this comment

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

I moved the clarification into the parameter description.

@jreback jreback added Testing pandas testing functions or related to the test suite Docs labels Feb 6, 2018
@TomAugspurger
Copy link
Contributor

@darcymeyer can you update?

@gfyoung gfyoung added this to the 0.24.0 milestone Jul 5, 2018
@gfyoung
Copy link
Member

gfyoung commented Jul 5, 2018

can you update?

@TomAugspurger : Sure can 🙂

Explicitly state that the `names` attribute
of `DataFrame.index` and `DataFrame.columns`
are being compared.

Closes pandas-devgh-19411.
@gfyoung
Copy link
Member

gfyoung commented Jul 6, 2018

@jreback @TomAugspurger : All is green and rebased. PTAL.

@jreback jreback merged commit 3cfb291 into pandas-dev:master Jul 6, 2018
@jreback
Copy link
Contributor

jreback commented Jul 6, 2018

thanks @gfyoung

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018
Explicitly state that the `names` attribute
of `DataFrame.index` and `DataFrame.columns`
are being compared.

Closes pandas-devgh-19411.
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.

check_names=False parameter for pandas.util.testing.assert_frame_equal applies to index.names but not columns.names
4 participants