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.

Sign up for GitHub

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

DOC: SS01 docstrings errors fixed #37845

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
85f8193
SS01 errors fixed
luikn Nov 14, 2020
f459a0b
trailing-whitespace error fixed
luikn Nov 14, 2020
31f4484
merge with upstream
luikn Nov 14, 2020
b6a0da2
added coded to code_checks.sh script
luikn Nov 14, 2020
90abe5d
fixed docstrings consistency
luikn Nov 14, 2020
e99135b
mistaken file
luikn Nov 14, 2020
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
10 changes: 10 additions & 0 deletions pandas/_libs/lib.pyx
View file
Open in desktop
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 a boolean if this is a float object.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these are the same as above (Return True)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changing docstrings to

Return True if given object is [type].


Returns
-------
bool
Expand All @@ -936,6 +940,8 @@ def is_float(obj: object) -> bool:

def is_integer(obj: object) -> bool:
"""
Return a boolean if this is a integer object.

Returns
-------
bool
Expand All @@ -945,6 +951,8 @@ def is_integer(obj: object) -> bool:

def is_bool(obj: object) -> bool:
"""
Return a boolean if this is a boolean object.

Returns
-------
bool
Expand All @@ -954,6 +962,8 @@ def is_bool(obj: object) -> bool:

def is_complex(obj: object) -> bool:
"""
Return a boolean if this is a complex object.

Returns
-------
bool
Expand Down