Skip to content

Commit 8cf4ab4

Browse files
authored
DOC: add missing parameters to offsets classes: MonthEnd, MonthBegin, BusinessMonthEnd, and BusinessMonthBegin (#53420)
1 parent 3a01556 commit 8cf4ab4

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

pandas/_libs/tslibs/offsets.pyx

+36
Original file line numberDiff line numberDiff line change
@@ -2690,6 +2690,13 @@ cdef class MonthEnd(MonthOffset):
26902690
26912691
MonthEnd goes to the next date which is an end of the month.
26922692
2693+
Parameters
2694+
----------
2695+
n : int, default 1
2696+
The number of months represented.
2697+
normalize : bool, default False
2698+
Normalize start/end dates to midnight before generating date range.
2699+
26932700
See Also
26942701
--------
26952702
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
@@ -2721,6 +2728,13 @@ cdef class MonthBegin(MonthOffset):
27212728
27222729
MonthBegin goes to the next date which is a start of the month.
27232730
2731+
Parameters
2732+
----------
2733+
n : int, default 1
2734+
The number of months represented.
2735+
normalize : bool, default False
2736+
Normalize start/end dates to midnight before generating date range.
2737+
27242738
See Also
27252739
--------
27262740
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
@@ -2751,6 +2765,17 @@ cdef class BusinessMonthEnd(MonthOffset):
27512765
27522766
BusinessMonthEnd goes to the next date which is the last business day of the month.
27532767
2768+
Parameters
2769+
----------
2770+
n : int, default 1
2771+
The number of months represented.
2772+
normalize : bool, default False
2773+
Normalize start/end dates to midnight before generating date range.
2774+
2775+
See Also
2776+
--------
2777+
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
2778+
27542779
Examples
27552780
--------
27562781
>>> ts = pd.Timestamp(2022, 11, 29)
@@ -2778,6 +2803,17 @@ cdef class BusinessMonthBegin(MonthOffset):
27782803
BusinessMonthBegin goes to the next date which is the first business day
27792804
of the month.
27802805
2806+
Parameters
2807+
----------
2808+
n : int, default 1
2809+
The number of months represented.
2810+
normalize : bool, default False
2811+
Normalize start/end dates to midnight before generating date range.
2812+
2813+
See Also
2814+
--------
2815+
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.
2816+
27812817
Examples
27822818
--------
27832819
>>> ts = pd.Timestamp(2022, 11, 30)

0 commit comments

Comments
 (0)