Skip to content

DOC: Add SA01 for pandas.api.types.is_string_dtype #59305

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 1 commit into from
Jul 24, 2024
Merged

DOC: Add SA01 for pandas.api.types.is_string_dtype #59305

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 @@ -304,7 +304,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_re PR07,SA01" \
-i "pandas.api.types.is_re_compilable PR07,SA01" \
-i "pandas.api.types.is_sparse SA01" \
-i "pandas.api.types.is_string_dtype SA01" \
-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
-i "pandas.api.types.union_categoricals RT03,SA01" \
Expand Down
5 changes: 5 additions & 0 deletions pandas/core/dtypes/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,11 @@ def is_string_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array or dtype is of the string dtype.

See Also
--------
api.types.is_string_dtype : Check whether the provided array or dtype
is of the string dtype.

Examples
--------
>>> from pandas.api.types import is_string_dtype
Expand Down
Loading