Skip to content

Commit bab5ea7

Browse files
darcymeyergfyoung
authored andcommitted
clarify docstring
1 parent d24a950 commit bab5ea7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

pandas/util/testing.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1304,7 +1304,12 @@ def assert_frame_equal(left, right, check_dtype=True,
13041304
5 digits (False) or 3 digits (True) after decimal points are compared.
13051305
If int, then specify the digits to compare
13061306
check_names : bool, default True
1307-
Whether to check the Index names attribute.
1307+
Whether to check that the `names` attribute for both the `index`
1308+
and `column` attributes of the DataFrame is identical, i.e.
1309+
1310+
* left.index.names == right.index.names
1311+
* left.columns.names == right.columns.names
1312+
13081313
by_blocks : bool, default False
13091314
Specify how to compare internal data. If False, compare by columns.
13101315
If True, compare by blocks.

0 commit comments

Comments
 (0)