Skip to content

Commit 25913f0

Browse files
committed
Add additional examples to pd.offsets.BusinessHour and CustomBusinessHour
This covers usage of datetime.time start/end values as well as multiple start and end values
1 parent 15e4680 commit 25913f0

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

pandas/_libs/tslibs/offsets.pyx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1622,9 +1622,17 @@ cdef class BusinessHour(BusinessMixin):
16221622
16231623
Examples
16241624
--------
1625+
>>> from datetime import time
16251626
>>> ts = pd.Timestamp(2022, 8, 5, 16)
16261627
>>> ts + pd.offsets.BusinessHour()
16271628
Timestamp('2022-08-08 09:00:00')
1629+
>>> ts + pd.offsets.BusinessHour(start="11:00")
1630+
Timestamp('2022-08-08 11:00:00')
1631+
>>> ts + pd.offsets.BusinessHour(end=time(19, 0))
1632+
Timestamp('2022-08-05 17:00:00')
1633+
>>> ts + pd.offsets.BusinessHour(start=[time(9, 0), "20:00"],
1634+
... end=["17:00", time(22, 0)])
1635+
Timestamp('2022-08-05 20:00:00')
16281636
"""
16291637

16301638
_prefix = "BH"
@@ -3626,9 +3634,17 @@ cdef class CustomBusinessHour(BusinessHour):
36263634
36273635
Examples
36283636
--------
3637+
>>> from datetime import time
36293638
>>> ts = pd.Timestamp(2022, 8, 5, 16)
36303639
>>> ts + pd.offsets.CustomBusinessHour()
36313640
Timestamp('2022-08-08 09:00:00')
3641+
>>> ts + pd.offsets.CustomBusinessHour(start="11:00")
3642+
Timestamp('2022-08-08 11:00:00')
3643+
>>> ts + pd.offsets.CustomBusinessHour(end=time(19, 0))
3644+
Timestamp('2022-08-05 17:00:00')
3645+
>>> ts + pd.offsets.CustomBusinessHour(start=[time(9, 0), "20:00"],
3646+
... end=["17:00", time(22, 0)])
3647+
Timestamp('2022-08-05 20:00:00')
36323648
"""
36333649

36343650
_prefix = "CBH"

0 commit comments

Comments
 (0)