Skip to content

Commit 1a7b53d

Browse files
DOC: fix PR01,SA01,ES01 for pandas.api.types.is_float
1 parent 05fa958 commit 1a7b53d

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
@@ -106,7 +106,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
106106
-i "pandas.Timestamp.resolution PR02" \
107107
-i "pandas.Timestamp.tzinfo GL08" \
108108
-i "pandas.Timestamp.year GL08" \
109-
-i "pandas.api.types.is_float PR01,SA01" \
110109
-i "pandas.api.types.is_integer PR01,SA01" \
111110
-i "pandas.api.types.is_iterator PR07,SA01" \
112111
-i "pandas.api.types.is_re_compilable PR07,SA01" \

pandas/_libs/lib.pyx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1089,9 +1089,23 @@ def is_float(obj: object) -> bool:
10891089
"""
10901090
Return True if given object is float.
10911091

1092+
This method checks whether the passed object is a float type. It
1093+
returns `True` if the object is a float, and `False` otherwise.
1094+
1095+
Parameters
1096+
----------
1097+
obj : object
1098+
The object to check for float type.
1099+
10921100
Returns
10931101
-------
10941102
bool
1103+
`True` if the object is of float type, otherwise `False`.
1104+
1105+
See Also
1106+
--------
1107+
api.types.is_integer : Check if an object is of integer type.
1108+
api.types.is_numeric_dtype : Check if an object is of numeric type.
10951109

10961110
Examples
10971111
--------

0 commit comments

Comments
 (0)