Skip to content
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

DOC: fix SA01,ES01 for pandas.errors.InvalidIndexError #60400

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 @@ -111,7 +111,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.resample.Resampler.var SA01" \
-i "pandas.errors.DuplicateLabelError 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 @@ -407,6 +407,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