Skip to content

Commit 4bf60ac

Browse files
Docs/update issue 52106 (#52161)
***updates*** - updated docstrings of pandas.offsers.MonthBegin, MonthEnd, BMonthBegin, BMonthEnd
1 parent bff8431 commit 4bf60ac

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

pandas/_libs/tslibs/offsets.pyx

+9-15
Original file line numberDiff line numberDiff line change
@@ -2546,7 +2546,6 @@ cdef class MonthEnd(MonthOffset):
25462546
DateOffset of one month end.
25472547
25482548
MonthEnd goes to the next date which is an end of the month.
2549-
To get the end of the current month pass the parameter n equals 0.
25502549
25512550
See Also
25522551
--------
@@ -2562,10 +2561,10 @@ cdef class MonthEnd(MonthOffset):
25622561
>>> ts + pd.offsets.MonthEnd()
25632562
Timestamp('2022-02-28 00:00:00')
25642563
2565-
If you want to get the end of the current month pass the parameter n equals 0:
2564+
If you want to get the end of the current month:
25662565
25672566
>>> ts = pd.Timestamp(2022, 1, 31)
2568-
>>> ts + pd.offsets.MonthEnd(0)
2567+
>>> pd.offsets.MonthEnd().rollforward(ts)
25692568
Timestamp('2022-01-31 00:00:00')
25702569
"""
25712570
_period_dtype_code = PeriodDtypeCode.M
@@ -2578,7 +2577,6 @@ cdef class MonthBegin(MonthOffset):
25782577
DateOffset of one month at beginning.
25792578
25802579
MonthBegin goes to the next date which is a start of the month.
2581-
To get the start of the current month pass the parameter n equals 0.
25822580
25832581
See Also
25842582
--------
@@ -2594,10 +2592,10 @@ cdef class MonthBegin(MonthOffset):
25942592
>>> ts + pd.offsets.MonthBegin()
25952593
Timestamp('2023-01-01 00:00:00')
25962594
2597-
If you want to get the start of the current month pass the parameter n equals 0:
2595+
If you want to get the start of the current month:
25982596
25992597
>>> ts = pd.Timestamp(2022, 12, 1)
2600-
>>> ts + pd.offsets.MonthBegin(0)
2598+
>>> pd.offsets.MonthBegin().rollback(ts)
26012599
Timestamp('2022-12-01 00:00:00')
26022600
"""
26032601
_prefix = "MS"
@@ -2609,7 +2607,6 @@ cdef class BusinessMonthEnd(MonthOffset):
26092607
DateOffset increments between the last business day of the month.
26102608
26112609
BusinessMonthEnd goes to the next date which is the last business day of the month.
2612-
To get the last business day of the current month pass the parameter n equals 0.
26132610
26142611
Examples
26152612
--------
@@ -2621,11 +2618,10 @@ cdef class BusinessMonthEnd(MonthOffset):
26212618
>>> ts + pd.offsets.BMonthEnd()
26222619
Timestamp('2022-12-30 00:00:00')
26232620
2624-
If you want to get the end of the current business month
2625-
pass the parameter n equals 0:
2621+
If you want to get the end of the current business month:
26262622
26272623
>>> ts = pd.Timestamp(2022, 11, 30)
2628-
>>> ts + pd.offsets.BMonthEnd(0)
2624+
>>> pd.offsets.BMonthEnd().rollforward(ts)
26292625
Timestamp('2022-11-30 00:00:00')
26302626
"""
26312627
_prefix = "BM"
@@ -2637,8 +2633,7 @@ cdef class BusinessMonthBegin(MonthOffset):
26372633
DateOffset of one month at the first business day.
26382634
26392635
BusinessMonthBegin goes to the next date which is the first business day
2640-
of the month. To get the first business day of the current month pass
2641-
the parameter n equals 0.
2636+
of the month.
26422637
26432638
Examples
26442639
--------
@@ -2650,11 +2645,10 @@ cdef class BusinessMonthBegin(MonthOffset):
26502645
>>> ts + pd.offsets.BMonthBegin()
26512646
Timestamp('2023-01-02 00:00:00')
26522647
2653-
If you want to get the start of the current business month pass
2654-
the parameter n equals 0:
2648+
If you want to get the start of the current business month:
26552649
26562650
>>> ts = pd.Timestamp(2022, 12, 1)
2657-
>>> ts + pd.offsets.BMonthBegin(0)
2651+
>>> pd.offsets.BMonthBegin().rollback(ts)
26582652
Timestamp('2022-12-01 00:00:00')
26592653
"""
26602654
_prefix = "BMS"

0 commit comments

Comments
 (0)