DOC: Apply doc sprint #20111
DOC: Apply doc sprint #20111
Conversation
|
@dtammaro Can you please udpate the title of the pull request, and copy the output of the script in the specified section? it's difficult to review otherwise |
pandas/core/frame.py
Outdated
| axis : {0 or 'index', 1 or 'columns'}, default 0 | ||
| Axis along which the function is applied |
There was a problem hiding this comment.
This line can have end with a period.
pandas/core/frame.py
Outdated
| @@ -4818,7 +4818,8 @@ def aggregate(self, func, axis=0, *args, **kwargs): | |||
|
|
|||
| def apply(self, func, axis=0, broadcast=None, raw=False, reduce=None, | |||
| result_type=None, args=(), **kwds): | |||
| """Applies function along an axis of the DataFrame. | |||
| """ | |||
| Apply function along an axis of the DataFrame. | |||
There was a problem hiding this comment.
Maybe "Apply a function along an axis of the DataFrame." (add "a" before "function").
pandas/core/frame.py
Outdated
| * 0 or 'index': apply function to each column | ||
| * 1 or 'columns': apply function to each row | ||
| * 1 or 'columns': apply function to each row. |
There was a problem hiding this comment.
These bullets should both have periods, or not. I don't really have a preference, but probably best to add a period to both.
pandas/core/frame.py
Outdated
| Additional keyword arguments will be passed as keywords to the function | ||
| array/series. | ||
|
|
||
| kwds : dictionary |
There was a problem hiding this comment.
@jorisvandenbossche remind me, what's the policy here? Just kwargs, with no type?
There was a problem hiding this comment.
Though probably just kwds in this case.
|
@datapythonista this doc-string prob needs another look, it is pretty long and complex so might be some more changes. |
|
This has been merged in #20202 |
Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):
scripts/validate_docstrings.py <your-function-or-method>git diff upstream/master -u -- "*.py" | flake8 --diffpython doc/make.py --single <your-function-or-method>Please include the output of the validation script below between the "```" ticks:
If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.
Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):
git diff upstream/master -u -- "*.py" | flake8 --diff