Skip to content

Commit 04fccd2

Browse files
DOC: fix PR07,SA01 for pandas.testing.assert_index_equal (#58880)
1 parent 71d067f commit 04fccd2

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
492492
-i "pandas.show_versions SA01" \
493493
-i "pandas.test SA01" \
494494
-i "pandas.testing.assert_extension_array_equal SA01" \
495-
-i "pandas.testing.assert_index_equal PR07,SA01" \
496495
-i "pandas.testing.assert_series_equal PR07,SA01" \
497496
-i "pandas.tseries.offsets.BDay PR02,SA01" \
498497
-i "pandas.tseries.offsets.BQuarterBegin PR02" \

pandas/_testing/asserters.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,9 @@ def assert_index_equal(
196196
Parameters
197197
----------
198198
left : Index
199+
The first index to compare.
199200
right : Index
201+
The second index to compare.
200202
exact : bool or {'equiv'}, default 'equiv'
201203
Whether to check the Index class, dtype and inferred_type
202204
are identical. If 'equiv', then RangeIndex can be substituted for
@@ -219,6 +221,11 @@ def assert_index_equal(
219221
Specify object name being compared, internally used to show appropriate
220222
assertion message.
221223
224+
See Also
225+
--------
226+
testing.assert_series_equal : Check that two Series are equal.
227+
testing.assert_frame_equal : Check that two DataFrames are equal.
228+
222229
Examples
223230
--------
224231
>>> from pandas import testing as tm

0 commit comments

Comments
 (0)