Skip to content

Commit 50f38f2

Browse files
DOC: fix SA01, ES01 for pandas.api.types.is_object_dtype
1 parent 2419343 commit 50f38f2

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
@@ -123,7 +123,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
123123
-i "pandas.api.types.is_iterator PR07,SA01" \
124124
-i "pandas.api.types.is_list_like SA01" \
125125
-i "pandas.api.types.is_named_tuple PR07,SA01" \
126-
-i "pandas.api.types.is_object_dtype SA01" \
127126
-i "pandas.api.types.is_re PR07,SA01" \
128127
-i "pandas.api.types.is_re_compilable PR07,SA01" \
129128
-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
@@ -139,6 +139,11 @@ def is_object_dtype(arr_or_dtype) -> bool:
139139
"""
140140
Check whether an array-like or dtype is of the object dtype.
141141
142+
This method examines the input to determine if it is of the
143+
object data type. Object dtype is a generic data type that can
144+
hold any Python objects, including strings, lists, and custom
145+
objects.
146+
142147
Parameters
143148
----------
144149
arr_or_dtype : array-like or dtype
@@ -149,6 +154,15 @@ def is_object_dtype(arr_or_dtype) -> bool:
149154
boolean
150155
Whether or not the array-like or dtype is of the object dtype.
151156
157+
See Also
158+
--------
159+
api.types.is_numeric_dtype : Check whether the provided array or dtype is of a
160+
numeric dtype.
161+
api.types.is_string_dtype : Check whether the provided array or dtype is of
162+
the string dtype.
163+
api.types.is_bool_dtype : Check whether the provided array or dtype is of a
164+
boolean dtype.
165+
152166
Examples
153167
--------
154168
>>> from pandas.api.types import is_object_dtype

0 commit comments

Comments
 (0)