Skip to content
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.

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

DOC: fix SA01, ES01 for pandas.api.types.is_object_dtype #59865

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_iterator PR07,SA01" \
-i "pandas.api.types.is_list_like SA01" \
-i "pandas.api.types.is_named_tuple PR07,SA01" \
-i "pandas.api.types.is_object_dtype SA01" \
-i "pandas.api.types.is_re PR07,SA01" \
-i "pandas.api.types.is_re_compilable PR07,SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
Expand Down
14 changes: 14 additions & 0 deletions pandas/core/dtypes/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,11 @@ def is_object_dtype(arr_or_dtype) -> bool:
"""
Check whether an array-like or dtype is of the object dtype.

This method examines the input to determine if it is of the
object data type. Object dtype is a generic data type that can
hold any Python objects, including strings, lists, and custom
objects.

Parameters
----------
arr_or_dtype : array-like or dtype
Expand All @@ -149,6 +154,15 @@ def is_object_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array-like or dtype is of the object dtype.

See Also
--------
api.types.is_numeric_dtype : Check whether the provided array or dtype is of a
numeric dtype.
api.types.is_string_dtype : Check whether the provided array or dtype is of
the string dtype.
api.types.is_bool_dtype : Check whether the provided array or dtype is of a
boolean dtype.

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