Skip to content

Commit f049159

Browse files
DOC: fix SA01, ES01 for pandas.api.types.is_object_dtype (#59865)
1 parent e38409c commit f049159

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
117117
-i "pandas.api.types.is_integer PR01,SA01" \
118118
-i "pandas.api.types.is_iterator PR07,SA01" \
119119
-i "pandas.api.types.is_named_tuple PR07,SA01" \
120-
-i "pandas.api.types.is_object_dtype SA01" \
121120
-i "pandas.api.types.is_re PR07,SA01" \
122121
-i "pandas.api.types.is_re_compilable PR07,SA01" \
123122
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \

pandas/core/dtypes/common.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,11 @@ def is_object_dtype(arr_or_dtype) -> bool:
141141
"""
142142
Check whether an array-like or dtype is of the object dtype.
143143
144+
This method examines the input to determine if it is of the
145+
object data type. Object dtype is a generic data type that can
146+
hold any Python objects, including strings, lists, and custom
147+
objects.
148+
144149
Parameters
145150
----------
146151
arr_or_dtype : array-like or dtype
@@ -151,6 +156,15 @@ def is_object_dtype(arr_or_dtype) -> bool:
151156
boolean
152157
Whether or not the array-like or dtype is of the object dtype.
153158
159+
See Also
160+
--------
161+
api.types.is_numeric_dtype : Check whether the provided array or dtype is of a
162+
numeric dtype.
163+
api.types.is_string_dtype : Check whether the provided array or dtype is of
164+
the string dtype.
165+
api.types.is_bool_dtype : Check whether the provided array or dtype is of a
166+
boolean dtype.
167+
154168
Examples
155169
--------
156170
>>> from pandas.api.types import is_object_dtype

0 commit comments

Comments
 (0)