Fix doc string of make_signature() function #23768
Conversation
|
Hello @srinivasreddy! Thanks for updating the PR.
Comment last updated on November 21, 2018 at 14:41 Hours UTC |
srinivasreddy
changed the title
Codecov Report
@@ Coverage Diff @@
## master #23768 +/- ##
=========================================
Coverage ? 92.29%
=========================================
Files ? 161
Lines ? 51490
Branches ? 0
=========================================
Hits ? 47521
Misses ? 3969
Partials ? 0
Continue to review full report at Codecov.
|
srinivasreddy
changed the title
pandas/util/_decorators.py
Outdated
| @@ -314,14 +314,15 @@ def indent(text, indents=1): | |||
|
|
|||
| def make_signature(func): | |||
| """ | |||
| Returns a string repr of the arg list of a func call, with any defaults. | |||
| Returns a string repr of tuple - the arg list of a func call with | |||
There was a problem hiding this comment.
Short description for docstrings should fit on one line
pandas/util/_decorators.py
Outdated
| @@ -314,14 +314,14 @@ def indent(text, indents=1): | |||
|
|
|||
| def make_signature(func): | |||
| """ | |||
| Returns a string repr of the arg list of a func call, with any defaults. | |||
| Returns a string repr of tuple - the arg list with any defaults and arg list. | |||
There was a problem hiding this comment.
I actually think this was better before the change - any reason you wanted to change this?
There was a problem hiding this comment.
docstring is wrong and outdated.
There was a problem hiding this comment.
Ah OK. Let's just say Returns a tuple containing the parameter list with default arguments and the parameter list or something to the effect. string repr is incorrect
|
@WillAyd Done with the changes. Please take a look again. |
|
I ran |
pandas/util/_decorators.py
Outdated
| @@ -314,14 +314,14 @@ def indent(text, indents=1): | |||
|
|
|||
| def make_signature(func): | |||
| """ | |||
| Returns a string repr of the arg list of a func call, with any defaults. | |||
| Returns a string repr of tuple - the arg list with any defaults and arg list. | |||
There was a problem hiding this comment.
Ah OK. Let's just say Returns a tuple containing the parameter list with default arguments and the parameter list or something to the effect. string repr is incorrect
pandas/util/_decorators.py
Outdated
|
|
||
| Examples | ||
| -------- | ||
| >>> def f(a,b,c=2) : | ||
| >>> def f(a,b,c=2): |
There was a problem hiding this comment.
Could still use spacing between parameters here
pandas/util/_decorators.py
Outdated
|
|
||
| Examples | ||
| -------- | ||
| >>> def f(a,b,c=2) : | ||
| >>> def f(a,b,c=2): | ||
| >>> return a*b*c |
There was a problem hiding this comment.
And between operators / operands here
|
@WillAyd Done |
|
@srinivasreddy looks like you have a travis failure on the code checks if you can take a look |
|
@WillAyd I have seen the difference between failing travis job and successful one, but i couldn't find any difference. Could you please help in figuring it? |
|
You've got a flake8 issue here in |
|
Done . Merge pls |
|
Thanks @srinivasreddy |
git diff upstream/master -u -- "*.py" | flake8 --diff