DOC: update Rolling.std docstring #20235
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pandas/core/window.py
Outdated
| %(name)s standard deviation | ||
| Calculate %(name)s standard deviation. | ||
|
|
||
| Normalized by N-1 by default. This can be changed using the ddof argument. |
There was a problem hiding this comment.
Can you put single backticks around ddof (like `ddof`) (because it is a parameter name)
pandas/core/window.py
Outdated
| The below example will show a rolling example | ||
|
|
||
| >>> s = pd.Series((5,5,5,5,6,7,9,10,5,5,5,5)) | ||
| >>> s.rolling(3).std(1) |
There was a problem hiding this comment.
if you use the default, I would leave out the 1 (just do std())
pandas/core/window.py
Outdated
| -------- | ||
| The below example will show a rolling example | ||
|
|
||
| >>> s = pd.Series((5,5,5,5,6,7,9,10,5,5,5,5)) |
There was a problem hiding this comment.
Can you make this PEP8: spaces after the comma.
Also: I would maybe make it a little bit shorter, and it is more typical to use a list to construct the data instead of a tuple.
There was a problem hiding this comment.
Can you address the second part of the comment as well?
pandas/core/window.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| Returns the same object type as determined by the caller of the %(name)s |
There was a problem hiding this comment.
Same comment here as on the other PR #20233
jreback
requested changes
Mar 10, 2018
pandas/core/window.py
Outdated
| 10 0.000000 | ||
| 11 0.000000 | ||
| dtype: float64 | ||
| >>> s.expanding(3).std() |
|
Changed a |
|
Ah good catch. Copy pasta fail. Thanks again! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.