Skip to content

Commit 3863a48

Browse files
authored
DOC: add missing parameters to offsets classes: BQuarterBegin, BQuarterEnd, QuarterBegin, QuarterEnd (#53378)
* DOC: add missing parameters to offsets classes: BQuarterBegin, BQuarterEnd, QuarterBegin, QuarterEnd * correct the description of the parameter n
1 parent cf2c967 commit 3863a48

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

pandas/_libs/tslibs/offsets.pyx

+52
Original file line numberDiff line numberDiff line change
@@ -2506,6 +2506,19 @@ cdef class BQuarterEnd(QuarterOffset):
25062506
startingMonth = 2 corresponds to dates like 2/28/2007, 5/31/2007, ...
25072507
startingMonth = 3 corresponds to dates like 3/30/2007, 6/29/2007, ...
25082508
2509+
Parameters
2510+
----------
2511+
n : int, default 1
2512+
The number of quarters represented.
2513+
normalize : bool, default False
2514+
Normalize start/end dates to midnight before generating date range.
2515+
startingMonth : int, default 3
2516+
A specific integer for the month of the year from which we start quarters.
2517+
2518+
See Also
2519+
--------
2520+
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
2521+
25092522
Examples
25102523
--------
25112524
>>> from pandas.tseries.offsets import BQuarterEnd
@@ -2534,6 +2547,19 @@ cdef class BQuarterBegin(QuarterOffset):
25342547
startingMonth = 2 corresponds to dates like 2/01/2007, 5/01/2007, ...
25352548
startingMonth = 3 corresponds to dates like 3/01/2007, 6/01/2007, ...
25362549
2550+
Parameters
2551+
----------
2552+
n : int, default 1
2553+
The number of quarters represented.
2554+
normalize : bool, default False
2555+
Normalize start/end dates to midnight before generating date range.
2556+
startingMonth : int, default 3
2557+
A specific integer for the month of the year from which we start quarters.
2558+
2559+
See Also
2560+
--------
2561+
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
2562+
25372563
Examples
25382564
--------
25392565
>>> from pandas.tseries.offsets import BQuarterBegin
@@ -2562,6 +2588,19 @@ cdef class QuarterEnd(QuarterOffset):
25622588
startingMonth = 2 corresponds to dates like 2/28/2007, 5/31/2007, ...
25632589
startingMonth = 3 corresponds to dates like 3/31/2007, 6/30/2007, ...
25642590
2591+
Parameters
2592+
----------
2593+
n : int, default 1
2594+
The number of quarters represented.
2595+
normalize : bool, default False
2596+
Normalize start/end dates to midnight before generating date range.
2597+
startingMonth : int, default 3
2598+
A specific integer for the month of the year from which we start quarters.
2599+
2600+
See Also
2601+
--------
2602+
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
2603+
25652604
Examples
25662605
--------
25672606
>>> ts = pd.Timestamp(2022, 1, 1)
@@ -2590,6 +2629,19 @@ cdef class QuarterBegin(QuarterOffset):
25902629
startingMonth = 2 corresponds to dates like 2/01/2007, 5/01/2007, ...
25912630
startingMonth = 3 corresponds to dates like 3/01/2007, 6/01/2007, ...
25922631
2632+
Parameters
2633+
----------
2634+
n : int, default 1
2635+
The number of quarters represented.
2636+
normalize : bool, default False
2637+
Normalize start/end dates to midnight before generating date range.
2638+
startingMonth : int, default 3
2639+
A specific integer for the month of the year from which we start quarters.
2640+
2641+
See Also
2642+
--------
2643+
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
2644+
25932645
Examples
25942646
--------
25952647
>>> ts = pd.Timestamp(2022, 1, 1)

0 commit comments

Comments
 (0)