File tree Expand file tree Collapse file tree 2 files changed +27
-1
lines changed
Expand file tree Collapse file tree 2 files changed +27
-1
lines changed Original file line number Diff line number Diff line change @@ -159,6 +159,7 @@ Properties
159159 CustomBusinessDay.weekmask
160160 CustomBusinessDay.calendar
161161 CustomBusinessDay.holidays
162+ CustomBusinessDay.offset
162163
163164Methods
164165~~~~~~~
Original file line number Diff line number Diff line change @@ -2123,7 +2123,32 @@ cdef class BusinessMixin(SingleConstructorOffset):
21232123 @property
21242124 def offset (self ):
21252125 """
2126- Alias for self._offset.
2126+ Return the time offset applied to the business day.
2127+
2128+ This property returns the timedelta that is added to the result
2129+ after calculating the business day offset. It allows shifting
2130+ the resulting timestamp by a fixed time duration.
2131+
2132+ Returns
2133+ -------
2134+ timedelta
2135+ The time offset applied after business day calculation.
2136+
2137+ See Also
2138+ --------
2139+ BusinessDay : Standard business day offset.
2140+ CustomBusinessDay : Custom business day offset with configurable parameters.
2141+
2142+ Examples
2143+ --------
2144+ >>> import datetime as dt
2145+ >>> cbd = pd.offsets.CustomBusinessDay()
2146+ >>> cbd.offset
2147+ datetime.timedelta(0)
2148+
2149+ >>> cbd_with_offset = pd.offsets.CustomBusinessDay(offset=dt.timedelta(hours=9))
2150+ >>> cbd_with_offset.offset
2151+ datetime.timedelta(seconds=32400)
21272152 """
21282153 # Alias for backward compat
21292154 return self ._offset
You can’t perform that action at this time.
0 commit comments