Skip to content

Commit

Permalink
DOC: fix SA01,ES01 for pandas.errors.InvalidIndexError (#60400)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Nov 25, 2024
1 parent 9fab4eb commit 00c2207
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 @@ -110,7 +110,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.resample.Resampler.transform PR01,RT03,SA01" \
-i "pandas.core.resample.Resampler.var SA01" \
-i "pandas.errors.IntCastingNaNError SA01" \
-i "pandas.errors.InvalidIndexError SA01" \
-i "pandas.errors.NullFrequencyError SA01" \
-i "pandas.errors.NumExprClobberingError SA01" \
-i "pandas.errors.NumbaUtilError SA01" \
Expand Down
10 changes: 10 additions & 0 deletions pandas/errors/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,16 @@ class InvalidIndexError(Exception):
"""
Exception raised when attempting to use an invalid index key.
This exception is triggered when a user attempts to access or manipulate
data in a pandas DataFrame or Series using an index key that is not valid
for the given object. This may occur in cases such as using a malformed
slice, a mismatched key for a ``MultiIndex``, or attempting to access an index
element that does not exist.
See Also
--------
MultiIndex : A multi-level, or hierarchical, index object for pandas objects.
Examples
--------
>>> idx = pd.MultiIndex.from_product([["x", "y"], [0, 1]])
Expand Down

0 comments on commit 00c2207

Please sign in to comment.