Skip to content

Commit 90fecaf

Browse files
lucasrodesluikn
authored andcommitted
DOC: SS01 docstrings errors fixed (#37845)
* SS01 errors fixed * trailing-whitespace error fixed * added coded to code_checks.sh script * fixed docstrings consistency * mistaken file Co-authored-by: lucasrodes <[email protected]>
1 parent b365b63 commit 90fecaf

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

ci/code_checks.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ fi
225225
### DOCSTRINGS ###
226226
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
227227

228-
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
228+
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
229229
$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
230230
RET=$(($RET + $?)) ; echo $MSG "DONE"
231231

pandas/_libs/lib.pyx

+11-1
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ def memory_usage_of_objects(arr: object[:]) -> int64_t:
118118

119119
def is_scalar(val: object) -> bool:
120120
"""
121+
Return True if given object is scalar.
122+
121123
Parameters
122124
----------
123125
val : object
@@ -927,6 +929,8 @@ def indices_fast(ndarray index, const int64_t[:] labels, list keys,
927929

928930
def is_float(obj: object) -> bool:
929931
"""
932+
Return True if given object is float.
933+
930934
Returns
931935
-------
932936
bool
@@ -936,6 +940,8 @@ def is_float(obj: object) -> bool:
936940

937941
def is_integer(obj: object) -> bool:
938942
"""
943+
Return True if given object is integer.
944+
939945
Returns
940946
-------
941947
bool
@@ -945,6 +951,8 @@ def is_integer(obj: object) -> bool:
945951

946952
def is_bool(obj: object) -> bool:
947953
"""
954+
Return True if given object is boolean.
955+
948956
Returns
949957
-------
950958
bool
@@ -954,6 +962,8 @@ def is_bool(obj: object) -> bool:
954962

955963
def is_complex(obj: object) -> bool:
956964
"""
965+
Return True if given object is complex.
966+
957967
Returns
958968
-------
959969
bool
@@ -971,7 +981,7 @@ cpdef bint is_interval(object obj):
971981

972982
def is_period(val: object) -> bool:
973983
"""
974-
Return a boolean if this is a Period object.
984+
Return True if given object is Period.
975985

976986
Returns
977987
-------

0 commit comments

Comments
 (0)