Skip to content

Commit b804514

Browse files
DOC: add SA01 for pandas.api.types.is_scalar (#58770)
1 parent c4f52ce commit b804514

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
346346
-i "pandas.api.types.is_period_dtype SA01" \
347347
-i "pandas.api.types.is_re PR07,SA01" \
348348
-i "pandas.api.types.is_re_compilable PR07,SA01" \
349-
-i "pandas.api.types.is_scalar SA01" \
350349
-i "pandas.api.types.is_signed_integer_dtype SA01" \
351350
-i "pandas.api.types.is_sparse SA01" \
352351
-i "pandas.api.types.is_string_dtype SA01" \

pandas/_libs/lib.pyx

+7
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,13 @@ def is_scalar(val: object) -> bool:
184184
bool
185185
Return True if given object is scalar.
186186

187+
See Also
188+
--------
189+
api.types.is_list_like : Check if the input is list-like.
190+
api.types.is_integer : Check if the input is an integer.
191+
api.types.is_float : Check if the input is a float.
192+
api.types.is_bool : Check if the input is a boolean.
193+
187194
Examples
188195
--------
189196
>>> import datetime

0 commit comments

Comments
 (0)