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

Merged
merged 12 commits into from
Sep 24, 2020
Merged

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

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4a04243
[IMP] - #35491 - added note docstring
erfannariman Jul 31, 2020
b809ca7
[FIX] - #35491 - remove trailing whitespace
erfannariman Jul 31, 2020
1656cd9
[IMP] - #35491 - added explanation about shape
erfannariman Jul 31, 2020
a911925
[FIX] - #35491 - labelS
erfannariman Jul 31, 2020
a5e2dd6
Merge branch 'master' into 35491-addd-note-compare
erfannariman Aug 9, 2020
f6c683d
[FIX] - 35491 - removed add
erfannariman Aug 9, 2020
723329e
added Raises section
erfannariman Aug 31, 2020
07b01d4
Merge branch 'master' into 35491-addd-note-compare
erfannariman Aug 31, 2020
e4d420b
Fix raise section
erfannariman Aug 31, 2020
c76b41a
Removed trailing whitespace
erfannariman Aug 31, 2020
a1a5f18
Adjustments after review
erfannariman Sep 1, 2020
871794a
Removed trailing whitespace
erfannariman Sep 1, 2020
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
9 changes: 9 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5932,14 +5932,23 @@ def _construct_result(self, result) -> "DataFrame":
The resulting index will be a MultiIndex with 'self' and 'other'
stacked alternately at the inner level.

Raises
------
ValueError
When the two DataFrames don't have identical labels or shape.

See Also
--------
Series.compare : Compare with another Series and show differences.
DataFrame.equals : Test whether two objects contain the same elements.

Notes
-----
Matching NaNs will not appear as a difference.

Can only compare identically-labeled
(i.e. same shape, identical row and column labels) DataFrames

Examples
--------
>>> df = pd.DataFrame(
Expand Down