Skip to content

Commit 845d1e2

Browse files
authored
DOC: Add SA01 for pandas.api.types.is_string_dtype (#59305)
DOC: Add see also for pandas.api.types.is_string_dtype
1 parent f732749 commit 845d1e2

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
@@ -304,7 +304,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
304304
-i "pandas.api.types.is_re PR07,SA01" \
305305
-i "pandas.api.types.is_re_compilable PR07,SA01" \
306306
-i "pandas.api.types.is_sparse SA01" \
307-
-i "pandas.api.types.is_string_dtype SA01" \
308307
-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \
309308
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
310309
-i "pandas.api.types.union_categoricals RT03,SA01" \

pandas/core/dtypes/common.py

+5
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,11 @@ def is_string_dtype(arr_or_dtype) -> bool:
558558
boolean
559559
Whether or not the array or dtype is of the string dtype.
560560
561+
See Also
562+
--------
563+
api.types.is_string_dtype : Check whether the provided array or dtype
564+
is of the string dtype.
565+
561566
Examples
562567
--------
563568
>>> from pandas.api.types import is_string_dtype

0 commit comments

Comments
 (0)