Skip to content

DOC: fix docstring api.types.is_re_compilable #60419

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

Merged
merged 2 commits into from
Nov 26, 2024
Merged

DOC: fix docstring api.types.is_re_compilable #60419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edc80fc
fix docstring api.types.is_re_compilable
sooooooing Nov 26, 2024
06192cd
fix lint error
sooooooing Nov 26, 2024
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 @@ -82,7 +82,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Timestamp.min PR02" \
-i "pandas.Timestamp.resolution PR02" \
-i "pandas.Timestamp.tzinfo GL08" \
-i "pandas.api.types.is_re_compilable PR07,SA01" \
-i "pandas.arrays.ArrowExtensionArray PR07,SA01" \
-i "pandas.arrays.IntegerArray SA01" \
-i "pandas.arrays.IntervalArray.length SA01" \
Expand Down
5 changes: 5 additions & 0 deletions pandas/core/dtypes/inference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,12 +190,17 @@ def is_re_compilable(obj: object) -> bool:
Parameters
----------
obj : The object to check
The object to check if the object can be compiled into a regex pattern instance.

Returns
-------
bool
Whether `obj` can be compiled as a regex pattern.

See Also
--------
api.types.is_re : Check if the object is a regex pattern instance.

Examples
--------
>>> from pandas.api.types import is_re_compilable
Expand Down