Skip to content

Commit ef35692

Browse files
DOC: fix SA01, ES01 for pandas.api.types.is_float_dtype
1 parent 2419343 commit ef35692

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_int64_dtype SA01" \
121120
-i "pandas.api.types.is_integer PR01,SA01" \

pandas/core/dtypes/common.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1275,6 +1275,9 @@ def is_float_dtype(arr_or_dtype) -> bool:
12751275
"""
12761276
Check whether the provided array or dtype is of a float dtype.
12771277
1278+
The function checks for floating-point data types, which represent real numbers
1279+
that may have fractional components.
1280+
12781281
Parameters
12791282
----------
12801283
arr_or_dtype : array-like or dtype
@@ -1285,6 +1288,15 @@ def is_float_dtype(arr_or_dtype) -> bool:
12851288
boolean
12861289
Whether or not the array or dtype is of a float dtype.
12871290
1291+
See Also
1292+
--------
1293+
api.types.is_numeric_dtype : Check whether the provided array or dtype is of
1294+
a numeric dtype.
1295+
api.types.is_integer_dtype : Check whether the provided array or dtype is of
1296+
an integer dtype.
1297+
api.types.is_object_dtype : Check whether an array-like or dtype is of the
1298+
object dtype.
1299+
12881300
Examples
12891301
--------
12901302
>>> from pandas.api.types import is_float_dtype

0 commit comments

Comments
 (0)