Skip to content

DOC: SS01 docstrings errors fixed #37845

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 6 commits into from
Nov 15, 2020
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
2 changes: 1 addition & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
12 changes: 11 additions & 1 deletion pandas/_libs/lib.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
-------
Expand Down