Skip to content

DOC: Add note to DataFrame.compare about only able to compare identically-labeled DataFrame objects #35491

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
Closed
erfannariman opened this issue Jul 31, 2020 · 1 comment · Fixed by #35492
Closed

DOC: Add note to DataFrame.compare about only able to compare identically-labeled DataFrame objects #35491

erfannariman opened this issue Jul 31, 2020 · 1 comment · Fixed by #35492
Assignees
@erfannariman
Labels
Docs

Comments

@erfannariman
Copy link
Member

erfannariman commented Jul 31, 2020 •
edited
Loading

Location of the documentation

pandas.core.frame::compare

Documentation problem

Right now there is not a note/warning that you can only compare dataframes with the same shape and index labels.

Suggested fix for documentation

Add note:

Note: the method can only compare identically-labeled DataFrame objects, this means DataFrames with identical row and column labels.
@erfannariman erfannariman added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jul 31, 2020
@erfannariman
Copy link
Member Author

take

@erfannariman erfannariman mentioned this issue Jul 31, 2020
Merged
4 tasks
@rhshadrach rhshadrach removed the Needs Triage Issue that has not been reviewed by a pandas team member label Aug 1, 2020
@rhshadrach rhshadrach added this to the Contributions Welcome milestone Aug 1, 2020
MarcoGorelli pushed a commit that referenced this issue Sep 24, 2020
@erfannariman
DOC: Add note to docstring DataFrame.compare about identical labels (#…
3a19556 
…35492)

* [IMP] - #35491 - added note docstring

* [FIX] - #35491 - remove trailing whitespace

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

* [FIX] - #35491 - labelS

* [FIX] - 35491 - removed add

* added Raises section

* Fix raise section

* Removed trailing whitespace

* Adjustments after review

* Removed trailing whitespace
kesmit13 pushed a commit to kesmit13/pandas that referenced this issue 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
Assignees

@erfannariman erfannariman

Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Add note to docstring DataFrame.compare about identical labels
2 participants
@erfannariman @rhshadrach