Skip to content

Commit 05fa958

Browse files
DOC: fix SA01, ES01 for pandas.testing.assert_extension_array_equal (#59975)
1 parent e740857 commit 05fa958

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
187187
-i "pandas.plotting.lag_plot RT03,SA01" \
188188
-i "pandas.plotting.scatter_matrix PR07,SA01" \
189189
-i "pandas.set_eng_float_format RT03,SA01" \
190-
-i "pandas.testing.assert_extension_array_equal SA01" \
191190
-i "pandas.tseries.offsets.BDay PR02,SA01" \
192191
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
193192
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \

pandas/_testing/asserters.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,10 @@ def assert_extension_array_equal(
701701
"""
702702
Check that left and right ExtensionArrays are equal.
703703
704+
This method compares two ``ExtensionArray`` instances for equality,
705+
including checks for missing values, the dtype of the arrays, and
706+
the exactness of the comparison (or tolerance when comparing floats).
707+
704708
Parameters
705709
----------
706710
left, right : ExtensionArray
@@ -726,6 +730,12 @@ def assert_extension_array_equal(
726730
727731
.. versionadded:: 2.0.0
728732
733+
See Also
734+
--------
735+
testing.assert_series_equal : Check that left and right ``Series`` are equal.
736+
testing.assert_frame_equal : Check that left and right ``DataFrame`` are equal.
737+
testing.assert_index_equal : Check that left and right ``Index`` are equal.
738+
729739
Notes
730740
-----
731741
Missing values are checked separately from valid values.

0 commit comments

Comments
 (0)