From e9ee4772d5819b4c24056242773409bfdc526647 Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sat, 18 May 2024 12:44:04 +0530 Subject: [PATCH] DOC: add SA01 for pandas.api.types.is_scalar --- ci/code_checks.sh | 1 - pandas/_libs/lib.pyx | 7 +++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 180083dbbb742..b33b2c61e2acb 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -347,7 +347,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.api.types.is_period_dtype SA01" \ -i "pandas.api.types.is_re PR07,SA01" \ -i "pandas.api.types.is_re_compilable PR07,SA01" \ - -i "pandas.api.types.is_scalar SA01" \ -i "pandas.api.types.is_signed_integer_dtype SA01" \ -i "pandas.api.types.is_sparse SA01" \ -i "pandas.api.types.is_string_dtype SA01" \ diff --git a/pandas/_libs/lib.pyx b/pandas/_libs/lib.pyx index 6a31ce84ed418..52582aa0bbfbf 100644 --- a/pandas/_libs/lib.pyx +++ b/pandas/_libs/lib.pyx @@ -184,6 +184,13 @@ def is_scalar(val: object) -> bool: bool Return True if given object is scalar. + See Also + -------- + api.types.is_list_like : Check if the input is list-like. + api.types.is_integer : Check if the input is an integer. + api.types.is_float : Check if the input is a float. + api.types.is_bool : Check if the input is a boolean. + Examples -------- >>> import datetime