Skip to content

DOC: fix PR01,SA01,ES01 for pandas.api.types.is_integer #60034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Timestamp.resolution PR02" \
-i "pandas.Timestamp.tzinfo GL08" \
-i "pandas.Timestamp.year GL08" \
-i "pandas.api.types.is_integer PR01,SA01" \
-i "pandas.api.types.is_iterator PR07,SA01" \
-i "pandas.api.types.is_re_compilable PR07,SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
Expand Down
14 changes: 14 additions & 0 deletions pandas/_libs/lib.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -1122,9 +1122,23 @@ def is_integer(obj: object) -> bool:
"""
Return True if given object is integer.

This method checks whether the passed object is an integer type. It
returns `True` if the object is an integer, and `False` otherwise.

Parameters
----------
obj : object
The object to check for integer type.

Returns
-------
bool
`True` if the object is of integer type, otherwise `False`.

See Also
--------
api.types.is_float : Check if an object is of float type.
api.types.is_numeric_dtype : Check if an object is of numeric type.

Examples
--------
Expand Down
Loading