DOC: update the pandas.Series.dt.is_quarter_end docstring #20279
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
dukebody
approved these changes
Mar 11, 2018
pandas/core/indexes/datetimes.py
Outdated
| -------- | ||
| >>> df = pd.DataFrame({'dates': pd.date_range("2017-03-30", | ||
| ... periods=4)}) | ||
| >>> df.assign(quarter = df.dates.dt.quarter, |
There was a problem hiding this comment.
I'd say no spaces around the = sign here to follow pep8.
pandas/core/indexes/datetimes.py
Outdated
| @@ -1739,7 +1739,33 @@ def freq(self, value): | |||
| is_quarter_end = _field_accessor( | |||
| 'is_quarter_end', | |||
| 'is_quarter_end', | |||
| "Logical indicating if last day of quarter (defined by frequency)") | |||
| """ | |||
| Return a boolean indicating whether the date is the last day of a | |||
There was a problem hiding this comment.
See if you can reprhase to get this on a single line
pandas/core/indexes/datetimes.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| is_quarter_end : Series of boolean. |
There was a problem hiding this comment.
is_quarter_end : Series or DatetimeIndex
The same type as the original data. Series will have the same
name and index. DatetimeIndex will have the same name.
pandas/core/indexes/datetimes.py
Outdated
|
|
||
| See Also | ||
| -------- | ||
| quarter : Return the quarter of the date. |
pandas/core/indexes/datetimes.py
Outdated
| Examples | ||
| -------- | ||
| >>> df = pd.DataFrame({'dates': pd.date_range("2017-03-30", | ||
| ... periods=4)}) |
There was a problem hiding this comment.
PEP: indent periods under the quote in date_range(
pandas/core/indexes/datetimes.py
Outdated
| >>> df = pd.DataFrame({'dates': pd.date_range("2017-03-30", | ||
| ... periods=4)}) | ||
| >>> df.assign(quarter = df.dates.dt.quarter, | ||
| ... is_quarter_end = df.dates.dt.is_quarter_end) |
There was a problem hiding this comment.
PEP8: one more space
pandas/core/indexes/datetimes.py
Outdated
| 1 2017-03-31 1 True | ||
| 2 2017-04-01 2 False | ||
| 3 2017-04-02 2 False | ||
| """) |
There was a problem hiding this comment.
Example for DatetimeIndex
[ci skip]
|
Thanks @janelle! |
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.