Skip to content

Commit a518b8f

Browse files
DOC: fix PR01,SA01,ES01 for pandas.api.types.is_integer (#60034)
1 parent 0bbca46 commit a518b8f

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
@@ -85,7 +85,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8585
-i "pandas.Timestamp.resolution PR02" \
8686
-i "pandas.Timestamp.tzinfo GL08" \
8787
-i "pandas.Timestamp.year GL08" \
88-
-i "pandas.api.types.is_integer PR01,SA01" \
8988
-i "pandas.api.types.is_iterator PR07,SA01" \
9089
-i "pandas.api.types.is_re_compilable PR07,SA01" \
9190
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \

pandas/_libs/lib.pyx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1122,9 +1122,23 @@ def is_integer(obj: object) -> bool:
11221122
"""
11231123
Return True if given object is integer.
11241124

1125+
This method checks whether the passed object is an integer type. It
1126+
returns `True` if the object is an integer, and `False` otherwise.
1127+
1128+
Parameters
1129+
----------
1130+
obj : object
1131+
The object to check for integer type.
1132+
11251133
Returns
11261134
-------
11271135
bool
1136+
`True` if the object is of integer type, otherwise `False`.
1137+
1138+
See Also
1139+
--------
1140+
api.types.is_float : Check if an object is of float type.
1141+
api.types.is_numeric_dtype : Check if an object is of numeric type.
11281142

11291143
Examples
11301144
--------

0 commit comments

Comments
 (0)