Skip to content

DOC: fix SA01, ES01 for pandas.testing.assert_extension_array_equal #59975

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 2 commits into from
Oct 5, 2024
Merged

DOC: fix SA01, ES01 for pandas.testing.assert_extension_array_equal #59975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67b0367
DOC: fix SA01, ES01 for pandas.testing.assert_extension_array_equal
tuhinsharma121 Oct 5, 2024
541057b
Merge branch 'main' into pandas.testing.assert_extension_array_equal
tuhinsharma121 Oct 5, 2024
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 @@ -189,7 +189,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.plotting.lag_plot RT03,SA01" \
-i "pandas.plotting.scatter_matrix PR07,SA01" \
-i "pandas.set_eng_float_format RT03,SA01" \
-i "pandas.testing.assert_extension_array_equal SA01" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \
Expand Down
10 changes: 10 additions & 0 deletions pandas/_testing/asserters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,10 @@ def assert_extension_array_equal(
"""
Check that left and right ExtensionArrays are equal.

This method compares two ``ExtensionArray`` instances for equality,
including checks for missing values, the dtype of the arrays, and
the exactness of the comparison (or tolerance when comparing floats).

Parameters
----------
left, right : ExtensionArray
Expand All @@ -726,6 +730,12 @@ def assert_extension_array_equal(

.. versionadded:: 2.0.0

See Also
--------
testing.assert_series_equal : Check that left and right ``Series`` are equal.
testing.assert_frame_equal : Check that left and right ``DataFrame`` are equal.
testing.assert_index_equal : Check that left and right ``Index`` are equal.

Notes
-----
Missing values are checked separately from valid values.
Expand Down
Loading