Skip to content

DOC: update the pandas.Series.dt.is_quarter_start docstring #20278

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

DOC: update the pandas.Series.dt.is_quarter_start docstring #20278

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6a6f2e2
docstring updated
janelle Mar 11, 2018
9c4891d
line length adjusted
janelle Mar 11, 2018
673cad9
line length adjusted
janelle Mar 11, 2018
85065ae
line ending adjusted
janelle Mar 11, 2018
1d9b4c8
code line length
janelle Mar 11, 2018
dc3e8b9
Updated [ci skip]
TomAugspurger Mar 14, 2018
7b9a775
pep8 [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 @@ -1735,7 +1735,33 @@ def freq(self, value):
is_quarter_start = _field_accessor(
'is_quarter_start',
'is_quarter_start',
"Logical indicating if first day of quarter (defined by frequency)")
"""
Return a boolean indicating whether the date is the first 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.

Does

Return an indicator for if the date is the first day of the quarter.

fit on a single line?

quarter.

Returns
-------
is_quarter_start : 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_start : 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.

See currently unresolved discussion in #20275 (comment)


is_quarter_end : Return a boolean indicating whether the date is the
last 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.

PEP8: periods under the opening quote in date_range(

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

Choose a reason for hiding this comment

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

PEP: one more space.

dates quarter is_quarter_start
0 2017-03-30 1 False
1 2017-03-31 1 False
2 2017-04-01 2 True
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.

Add a second example with just DatetimeIndex.is_quarter_start.

is_quarter_end = _field_accessor(
'is_quarter_end',
'is_quarter_end',
Expand Down