diff --git a/ci/code_checks.sh b/ci/code_checks.sh index b5a6e32caa8e0..3eeee61f62a7e 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -225,7 +225,7 @@ fi ### DOCSTRINGS ### if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then - MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS02, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG + MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03 RET=$(($RET + $?)) ; echo $MSG "DONE" diff --git a/pandas/_libs/lib.pyx b/pandas/_libs/lib.pyx index 0b0334d52c1e9..f6d2d6e63340f 100644 --- a/pandas/_libs/lib.pyx +++ b/pandas/_libs/lib.pyx @@ -118,6 +118,8 @@ def memory_usage_of_objects(arr: object[:]) -> int64_t: def is_scalar(val: object) -> bool: """ + Return True if given object is scalar. + Parameters ---------- val : object @@ -927,6 +929,8 @@ def indices_fast(ndarray index, const int64_t[:] labels, list keys, def is_float(obj: object) -> bool: """ + Return True if given object is float. + Returns ------- bool @@ -936,6 +940,8 @@ def is_float(obj: object) -> bool: def is_integer(obj: object) -> bool: """ + Return True if given object is integer. + Returns ------- bool @@ -945,6 +951,8 @@ def is_integer(obj: object) -> bool: def is_bool(obj: object) -> bool: """ + Return True if given object is boolean. + Returns ------- bool @@ -954,6 +962,8 @@ def is_bool(obj: object) -> bool: def is_complex(obj: object) -> bool: """ + Return True if given object is complex. + Returns ------- bool @@ -971,7 +981,7 @@ cpdef bint is_interval(object obj): def is_period(val: object) -> bool: """ - Return a boolean if this is a Period object. + Return True if given object is Period. Returns -------