Skip to content

Commit 71b3058

Browse files
tuhinsharma121KevsterAmp
authored andcommitted
DOC: fix PR01,SA01 for pandas.errors.UndefinedVariableError (pandas-dev#60570)
1 parent c939879 commit 71b3058

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9393
-i "pandas.core.resample.Resampler.std SA01" \
9494
-i "pandas.core.resample.Resampler.transform PR01,RT03,SA01" \
9595
-i "pandas.core.resample.Resampler.var SA01" \
96-
-i "pandas.errors.UndefinedVariableError PR01,SA01" \
9796
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
9897
-i "pandas.plotting.andrews_curves RT03,SA01" \
9998
-i "pandas.tseries.offsets.BDay PR02,SA01" \

pandas/errors/__init__.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,20 @@ class UndefinedVariableError(NameError):
588588
589589
It will also specify whether the undefined variable is local or not.
590590
591+
Parameters
592+
----------
593+
name : str
594+
The name of the undefined variable.
595+
is_local : bool or None, optional
596+
Indicates whether the undefined variable is considered a local variable.
597+
If ``True``, the error message specifies it as a local variable.
598+
If ``False`` or ``None``, the variable is treated as a non-local name.
599+
600+
See Also
601+
--------
602+
DataFrame.query : Query the columns of a DataFrame with a boolean expression.
603+
DataFrame.eval : Evaluate a string describing operations on DataFrame columns.
604+
591605
Examples
592606
--------
593607
>>> df = pd.DataFrame({"A": [1, 1, 1]})

0 commit comments

Comments
 (0)