Skip to content

Commit

Permalink
DOC: fix SA01 for pandas.api.types.is_interval_dtype (#59863)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Sep 25, 2024
1 parent a9e30c5 commit 0962007
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_float PR01,SA01" \
-i "pandas.api.types.is_hashable PR01,RT03,SA01" \
-i "pandas.api.types.is_integer PR01,SA01" \
-i "pandas.api.types.is_interval_dtype SA01" \
-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" \
Expand Down
9 changes: 9 additions & 0 deletions pandas/core/dtypes/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,15 @@ def is_interval_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array-like or dtype is of the Interval dtype.
See Also
--------
api.types.is_object_dtype : Check whether an array-like or dtype is of the
object dtype.
api.types.is_numeric_dtype : Check whether the provided array or dtype is
of a numeric dtype.
api.types.is_categorical_dtype : Check whether an array-like or dtype is of
the Categorical dtype.
Examples
--------
>>> from pandas.core.dtypes.common import is_interval_dtype
Expand Down

0 comments on commit 0962007

Please sign in to comment.