Skip to content

Commit b6f6957

Browse files
mohdkashif93Kashif
and
Kashif
authored
Added docs to fix GL08 errors in CustomBusinessHours (#37846)
Co-authored-by: Kashif <[email protected]>
1 parent ea19bd9 commit b6f6957

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

pandas/_libs/tslibs/offsets.pyx

+26
Original file line numberDiff line numberDiff line change
@@ -1403,6 +1403,19 @@ cdef class BusinessDay(BusinessMixin):
14031403
cdef class BusinessHour(BusinessMixin):
14041404
"""
14051405
DateOffset subclass representing possibly n business hours.
1406+
1407+
Parameters
1408+
----------
1409+
n : int, default 1
1410+
The number of months represented.
1411+
normalize : bool, default False
1412+
Normalize start/end dates to midnight before generating date range.
1413+
weekmask : str, Default 'Mon Tue Wed Thu Fri'
1414+
Weekmask of valid business days, passed to ``numpy.busdaycalendar``.
1415+
start : str, default "09:00"
1416+
Start time of your custom business hour in 24h format.
1417+
end : str, default: "17:00"
1418+
End time of your custom business hour in 24h format.
14061419
"""
14071420

14081421
_prefix = "BH"
@@ -3251,6 +3264,19 @@ cdef class CustomBusinessDay(BusinessDay):
32513264
cdef class CustomBusinessHour(BusinessHour):
32523265
"""
32533266
DateOffset subclass representing possibly n custom business days.
3267+
3268+
Parameters
3269+
----------
3270+
n : int, default 1
3271+
The number of months represented.
3272+
normalize : bool, default False
3273+
Normalize start/end dates to midnight before generating date range.
3274+
weekmask : str, Default 'Mon Tue Wed Thu Fri'
3275+
Weekmask of valid business days, passed to ``numpy.busdaycalendar``.
3276+
start : str, default "09:00"
3277+
Start time of your custom business hour in 24h format.
3278+
end : str, default: "17:00"
3279+
End time of your custom business hour in 24h format.
32543280
"""
32553281

32563282
_prefix = "CBH"

0 commit comments

Comments
 (0)