Skip to content

DOC: update the pandas.Series.dt.is_quarter_end docstring #20279

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 2 commits into from
Mar 14, 2018
Merged

DOC: update the pandas.Series.dt.is_quarter_end docstring #20279

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
698f76a
docstring added
janelle Mar 11, 2018
721c955
Updated [ci skip]
TomAugspurger Mar 14, 2018
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
28 changes: 27 additions & 1 deletion pandas/core/indexes/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

See if you can reprhase to get this on a single line

quarter.

Returns
-------
is_quarter_end : Series of boolean.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.


See Also
--------
quarter : Return the quarter of the date.
Copy link
Contributor

Choose a reason for hiding this comment

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

#20275 (comment)


is_quarter_start : Return a boolean indicating whether the date is the
first day of the quarter.

Examples
--------
>>> df = pd.DataFrame({'dates': pd.date_range("2017-03-30",
... periods=4)})
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP: indent periods under the quote in date_range(

>>> df.assign(quarter = df.dates.dt.quarter,
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd say no spaces around the = sign here to follow pep8.

... is_quarter_end = df.dates.dt.is_quarter_end)
Copy link
Contributor

Choose a reason for hiding this comment

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

PEP8: one more space

dates quarter is_quarter_end
0 2017-03-30 1 False
1 2017-03-31 1 True
2 2017-04-01 2 False
3 2017-04-02 2 False
""")
Copy link
Contributor

Choose a reason for hiding this comment

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

Example for DatetimeIndex

is_year_start = _field_accessor(
'is_year_start',
'is_year_start',
Expand Down