Skip to content

Commit 0039158

Browse files
authored
DOC: Correct description of day_opt in shift_month (#24585)
1 parent 268150f commit 0039158

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

pandas/_libs/tslibs/offsets.pyx

+5-1
Original file line numberDiff line numberDiff line change
@@ -847,11 +847,15 @@ def shift_month(stamp: datetime, months: int,
847847
----------
848848
stamp : datetime or Timestamp
849849
months : int
850-
day_opt : None, 'start', 'end', or an integer
850+
day_opt : None, 'start', 'end', 'business_start', 'business_end', or int
851851
None: returned datetimelike has the same day as the input, or the
852852
last day of the month if the new month is too short
853853
'start': returned datetimelike has day=1
854854
'end': returned datetimelike has day on the last day of the month
855+
'business_start': returned datetimelike has day on the first
856+
business day of the month
857+
'business_end': returned datetimelike has day on the last
858+
business day of the month
855859
int: returned datetimelike has day equal to day_opt
856860

857861
Returns

0 commit comments

Comments
 (0)