Skip to content

Commit

Permalink
DOC: fix SA01, ES01 for pandas.testing.assert_extension_array_equal (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Oct 5, 2024
1 parent e740857 commit 05fa958
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,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
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

0 comments on commit 05fa958

Please sign in to comment.