Skip to content

Added docs to fix GL08 errors in CustomBusinessHours #37846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 17, 2020
Merged

Added docs to fix GL08 errors in CustomBusinessHours #37846

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1403,6 +1403,19 @@ cdef class BusinessDay(BusinessMixin):
cdef class BusinessHour(BusinessMixin):
"""
DateOffset subclass representing possibly n business hours.

Parameters
----------
n : int, default 1
The number of months represented.
normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
weekmask : str, Default 'Mon Tue Wed Thu Fri'
Weekmask of valid business days, passed to ``numpy.busdaycalendar``.
start : str, default "09:00"
Start time of your custom business hour in 24h format.
end : str, default: "17:00"
End time of your custom business hour in 24h format.
"""

_prefix = "BH"
Expand Down Expand Up @@ -3251,6 +3264,19 @@ cdef class CustomBusinessDay(BusinessDay):
cdef class CustomBusinessHour(BusinessHour):
"""
DateOffset subclass representing possibly n custom business days.

Parameters
----------
n : int, default 1
The number of months represented.
normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
weekmask : str, Default 'Mon Tue Wed Thu Fri'
Weekmask of valid business days, passed to ``numpy.busdaycalendar``.
start : str, default "09:00"
Start time of your custom business hour in 24h format.
end : str, default: "17:00"
End time of your custom business hour in 24h format.
"""

_prefix = "CBH"
Expand Down