Skip to content

DOC: Add note to docstring DataFrame.compare about identical labels #35492

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

Jump to bottom
Merged
merged 12 commits into from
Sep 24, 2020
Merged

DOC: Add note to docstring DataFrame.compare about identical labels #35492

merged 12 commits into from
Sep 24, 2020

Conversation

erfannariman
Copy link
Member

@pep8speaks
Copy link

pep8speaks commented Jul 31, 2020 •
edited
Loading

Hello @erfannariman! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-09-01 16:35:46 UTC

@erfannariman
Copy link
Member Author

@simonjayhawkins do you have time to check this PR? Thanks

@simonjayhawkins
Copy link
Member

will look soon

MarcoGorelli
MarcoGorelli reviewed Aug 23, 2020
View reviewed changes
simonjayhawkins
simonjayhawkins requested changes Aug 24, 2020
View reviewed changes
Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

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

Thanks @erfannariman for the PR. generally lgtm. ex @MarcoGorelli comment and explicit mention of ValueError in a raises section.

@erfannariman
Copy link
Member Author

@MarcoGorelli I added DataFrame.equals to "see also" section as well since these methods are quite alike. If that is not oke, let me know and I'll remove it.

simonjayhawkins
simonjayhawkins approved these changes Aug 31, 2020
View reviewed changes
Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

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

Thanks @erfannariman lgtm pending green

@simonjayhawkins simonjayhawkins added this to the 1.2 milestone Aug 31, 2020
@erfannariman
Copy link
Member Author

@MarcoGorelli Do you have any idea what's the cause of this test failing? I can't figure out.

@simonjayhawkins
Copy link
Member

@MarcoGorelli Do you have any idea what's the cause of this test failing? I can't figure out.

fixed in #36011, restarted job so should pass.

@erfannariman
Copy link
Member Author

ping @MarcoGorelli @simonjayhawkins

MarcoGorelli
MarcoGorelli suggested changes Sep 1, 2020
View reviewed changes
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Thanks! Another couple of comments, should be good after this

MarcoGorelli
MarcoGorelli approved these changes Sep 2, 2020
View reviewed changes
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Great, thanks @erfannariman !

@erfannariman
Copy link
Member Author

ping @jreback

@jbrockmendel
Copy link
Member

LGTM

@MarcoGorelli MarcoGorelli merged commit 3a19556 into pandas-dev:master Sep 24, 2020
@MarcoGorelli
Copy link
Member

Thanks @erfannariman

@erfannariman erfannariman deleted the 35491-addd-note-compare branch September 24, 2020 08:07
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
@erfannariman
DOC: Add note to docstring DataFrame.compare about identical labels (p…
62608f9 
…andas-dev#35492)

* [IMP] - pandas-dev#35491 - added note docstring

* [FIX] - pandas-dev#35491 - remove trailing whitespace

* [IMP] - pandas-dev#35491 - added explanation about shape

* [FIX] - pandas-dev#35491 - labelS

* [FIX] - 35491 - removed add

* added Raises section

* Fix raise section

* Removed trailing whitespace

* Adjustments after review

* Removed trailing whitespace
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simonjayhawkins simonjayhawkins simonjayhawkins approved these changes

@MarcoGorelli MarcoGorelli MarcoGorelli approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.2
Development

Successfully merging this pull request may close these issues.

DOC: Add note to DataFrame.compare about only able to compare identically-labeled DataFrame objects
5 participants
@erfannariman @pep8speaks @simonjayhawkins @jbrockmendel @MarcoGorelli