Skip to content

DOC: fix PR07,SA01 for pandas.testing.assert_index_equal #58880

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 1 commit into from
Jun 1, 2024
Merged

DOC: fix PR07,SA01 for pandas.testing.assert_index_equal #58880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.show_versions SA01" \
-i "pandas.test SA01" \
-i "pandas.testing.assert_extension_array_equal SA01" \
-i "pandas.testing.assert_index_equal PR07,SA01" \
-i "pandas.testing.assert_series_equal PR07,SA01" \
-i "pandas.timedelta_range SA01" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/_testing/asserters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,9 @@ def assert_index_equal(
Parameters
----------
left : Index
The first index to compare.
right : Index
The second index to compare.
exact : bool or {'equiv'}, default 'equiv'
Whether to check the Index class, dtype and inferred_type
are identical. If 'equiv', then RangeIndex can be substituted for
Expand All @@ -219,6 +221,11 @@ def assert_index_equal(
Specify object name being compared, internally used to show appropriate
assertion message.

See Also
--------
testing.assert_series_equal : Check that two Series are equal.
testing.assert_frame_equal : Check that two DataFrames are equal.

Examples
--------
>>> from pandas import testing as tm
Expand Down
Loading