Skip to content

Commit b91be12

Browse files
DOC: fix SA01, ES01 for pandas.api.types.is_float_dtype (#59861)
1 parent dc24410 commit b91be12

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
115115
-i "pandas.api.types.is_dict_like PR07,SA01" \
116116
-i "pandas.api.types.is_file_like PR07,SA01" \
117117
-i "pandas.api.types.is_float PR01,SA01" \
118-
-i "pandas.api.types.is_float_dtype SA01" \
119118
-i "pandas.api.types.is_hashable PR01,RT03,SA01" \
120119
-i "pandas.api.types.is_integer PR01,SA01" \
121120
-i "pandas.api.types.is_interval_dtype SA01" \

pandas/core/dtypes/common.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1285,6 +1285,9 @@ def is_float_dtype(arr_or_dtype) -> bool:
12851285
"""
12861286
Check whether the provided array or dtype is of a float dtype.
12871287
1288+
The function checks for floating-point data types, which represent real numbers
1289+
that may have fractional components.
1290+
12881291
Parameters
12891292
----------
12901293
arr_or_dtype : array-like or dtype
@@ -1295,6 +1298,15 @@ def is_float_dtype(arr_or_dtype) -> bool:
12951298
boolean
12961299
Whether or not the array or dtype is of a float dtype.
12971300
1301+
See Also
1302+
--------
1303+
api.types.is_numeric_dtype : Check whether the provided array or dtype is of
1304+
a numeric dtype.
1305+
api.types.is_integer_dtype : Check whether the provided array or dtype is of
1306+
an integer dtype.
1307+
api.types.is_object_dtype : Check whether an array-like or dtype is of the
1308+
object dtype.
1309+
12981310
Examples
12991311
--------
13001312
>>> from pandas.api.types import is_float_dtype

0 commit comments

Comments
 (0)