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.

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

DOC: fix PR01,SA01 for pandas.errors.UndefinedVariableError #60570

Merged
merged 1 commit into from
Dec 16, 2024
Merged

DOC: fix PR01,SA01 for pandas.errors.UndefinedVariableError #60570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -93,7 +93,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.resample.Resampler.std SA01" \
-i "pandas.core.resample.Resampler.transform PR01,RT03,SA01" \
-i "pandas.core.resample.Resampler.var SA01" \
-i "pandas.errors.UndefinedVariableError PR01,SA01" \
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
-i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
-i "pandas.plotting.andrews_curves RT03,SA01" \
Expand Down
14 changes: 14 additions & 0 deletions pandas/errors/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,20 @@ class UndefinedVariableError(NameError):

It will also specify whether the undefined variable is local or not.

Parameters
----------
name : str
The name of the undefined variable.
is_local : bool or None, optional
Indicates whether the undefined variable is considered a local variable.
If ``True``, the error message specifies it as a local variable.
If ``False`` or ``None``, the variable is treated as a non-local name.

See Also
--------
DataFrame.query : Query the columns of a DataFrame with a boolean expression.
DataFrame.eval : Evaluate a string describing operations on DataFrame columns.

Examples
--------
>>> df = pd.DataFrame({"A": [1, 1, 1]})
Expand Down
Loading