Skip to content

DOC: fix PR07,SA01 for pandas.testing.assert_series_equal #58888

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.set_eng_float_format RT03,SA01" \
-i "pandas.show_versions SA01" \
-i "pandas.testing.assert_extension_array_equal SA01" \
-i "pandas.testing.assert_series_equal PR07,SA01" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
-i "pandas.tseries.offsets.BQuarterBegin PR02" \
-i "pandas.tseries.offsets.BQuarterBegin.freqstr SA01" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/_testing/asserters.py
Original file line number Diff line number Diff line change
Expand Up @@ -857,7 +857,9 @@ def assert_series_equal(
Parameters
----------
left : Series
First Series to compare.
right : Series
Second Series to compare.
check_dtype : bool, default True
Whether to check the Series dtype is identical.
check_index_type : bool or {'equiv'}, default 'equiv'
Expand Down Expand Up @@ -908,6 +910,11 @@ def assert_series_equal(

.. versionadded:: 1.5.0

See Also
--------
testing.assert_index_equal : Check that two Indexes are equal.
testing.assert_frame_equal : Check that two DataFrames are equal.

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