Skip to content
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

DOC: add missing parameters to offsets classes: BQuarterBegin, BQuarterEnd, QuarterBegin, QuarterEnd #53378

Merged
merged 3 commits into from
May 26, 2023
Merged

DOC: add missing parameters to offsets classes: BQuarterBegin, BQuarterEnd, QuarterBegin, QuarterEnd #53378

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fccbd70
DOC: add missing parameters to offsets classes: BQuarterBegin, BQuart…
natmokval May 24, 2023
f3ce081
correct the description of the parameter n
natmokval May 25, 2023
c7ec3e1
Merge branch 'main' into 52431-add-missing-parameters-to-offsets-clas…
natmokval May 25, 2023
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
52 changes: 52 additions & 0 deletions pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2506,6 +2506,19 @@ cdef class BQuarterEnd(QuarterOffset):
startingMonth = 2 corresponds to dates like 2/28/2007, 5/31/2007, ...
startingMonth = 3 corresponds to dates like 3/30/2007, 6/29/2007, ...

Parameters
----------
n : int, default 1
The number of years represented.
Copy link
Member

Choose a reason for hiding this comment

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

is this years or quarters?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks, @MarcoGorelli , you are right. n represents quarters, my mistake. I''l correct this.

normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
startingMonth : int, default 3
A specific integer for the month of the year from which we start Quarters.

See Also
--------
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.

Examples
--------
>>> from pandas.tseries.offsets import BQuarterEnd
Expand Down Expand Up @@ -2534,6 +2547,19 @@ cdef class BQuarterBegin(QuarterOffset):
startingMonth = 2 corresponds to dates like 2/01/2007, 5/01/2007, ...
startingMonth = 3 corresponds to dates like 3/01/2007, 6/01/2007, ...

Parameters
----------
n : int, default 1
The number of years represented.
normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
startingMonth : int, default 3
A specific integer for the month of the year from which we start Quarters.

See Also
--------
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.

Examples
--------
>>> from pandas.tseries.offsets import BQuarterBegin
Expand Down Expand Up @@ -2562,6 +2588,19 @@ cdef class QuarterEnd(QuarterOffset):
startingMonth = 2 corresponds to dates like 2/28/2007, 5/31/2007, ...
startingMonth = 3 corresponds to dates like 3/31/2007, 6/30/2007, ...

Parameters
----------
n : int, default 1
The number of years represented.
normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
startingMonth : int, default 3
A specific integer for the month of the year from which we start Quarters.

See Also
--------
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.

Examples
--------
>>> ts = pd.Timestamp(2022, 1, 1)
Expand Down Expand Up @@ -2590,6 +2629,19 @@ cdef class QuarterBegin(QuarterOffset):
startingMonth = 2 corresponds to dates like 2/01/2007, 5/01/2007, ...
startingMonth = 3 corresponds to dates like 3/01/2007, 6/01/2007, ...

Parameters
----------
n : int, default 1
The number of years represented.
normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
startingMonth : int, default 3
A specific integer for the month of the year from which we start Quarters.

See Also
--------
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.

Examples
--------
>>> ts = pd.Timestamp(2022, 1, 1)
Expand Down