Skip to content

Commit b4707b8

Browse files
sooooooingKevsterAmp
authored andcommitted
DOC: fix docstring api.types.is_re_compilable (pandas-dev#60419)
* fix docstring api.types.is_re_compilable * fix lint error
1 parent f60048c commit b4707b8

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8282
-i "pandas.Timestamp.min PR02" \
8383
-i "pandas.Timestamp.resolution PR02" \
8484
-i "pandas.Timestamp.tzinfo GL08" \
85-
-i "pandas.api.types.is_re_compilable PR07,SA01" \
8685
-i "pandas.arrays.ArrowExtensionArray PR07,SA01" \
8786
-i "pandas.arrays.IntegerArray SA01" \
8887
-i "pandas.arrays.IntervalArray.length SA01" \

pandas/core/dtypes/inference.py

+5
Original file line numberDiff line numberDiff line change
@@ -190,12 +190,17 @@ def is_re_compilable(obj: object) -> bool:
190190
Parameters
191191
----------
192192
obj : The object to check
193+
The object to check if the object can be compiled into a regex pattern instance.
193194
194195
Returns
195196
-------
196197
bool
197198
Whether `obj` can be compiled as a regex pattern.
198199
200+
See Also
201+
--------
202+
api.types.is_re : Check if the object is a regex pattern instance.
203+
199204
Examples
200205
--------
201206
>>> from pandas.api.types import is_re_compilable

0 commit comments

Comments
 (0)