Skip to content

Commit 1ef6b68

Browse files
DOC: Fix ES01,PR02,SA01 for pandas.tseries.offsets.BusinessHour
1 parent 924573a commit 1ef6b68

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7070
"$BASE_DIR"/scripts/validate_docstrings.py \
7171
--format=actions \
7272
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
73-
-i "pandas.tseries.offsets.BusinessHour PR02,SA01" \
7473
-i "pandas.tseries.offsets.CustomBusinessHour PR02,SA01" \
7574
-i "pandas.tseries.offsets.FY5253Quarter.is_on_offset GL08" \
7675
-i "pandas.tseries.offsets.LastWeekOfMonth.is_on_offset GL08" \

doc/source/reference/offset_frequency.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ Properties
109109
BusinessHour.normalize
110110
BusinessHour.rule_code
111111
BusinessHour.n
112+
BusinessHour.offset
112113
BusinessHour.start
113114
BusinessHour.end
114115
BusinessHour.weekmask

pandas/_libs/tslibs/offsets.pyx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2605,7 +2605,12 @@ cdef class BusinessHour(BusinessMixin):
26052605
"""
26062606
DateOffset subclass representing possibly n business hours.
26072607
2608-
Parameters
2608+
BusinessHour is a date offset that advances time by a number of business
2609+
hours. By default, business hours are from 9:00 AM to 5:00 PM on weekdays.
2610+
The ``start`` and ``end`` parameters can be used to customize the business
2611+
hours window, and multiple intervals can be specified by passing lists.
2612+
2613+
Attributes
26092614
----------
26102615
n : int, default 1
26112616
The number of hours represented.
@@ -2618,6 +2623,13 @@ cdef class BusinessHour(BusinessMixin):
26182623
offset : timedelta, default timedelta(0)
26192624
Time offset to apply.
26202625
2626+
See Also
2627+
--------
2628+
:class:`~pandas.tseries.offsets.CustomBusinessHour` :
2629+
DateOffset subclass with custom weekmask and holidays.
2630+
:class:`~pandas.tseries.offsets.BusinessDay` :
2631+
DateOffset subclass representing possibly n business days.
2632+
26212633
Examples
26222634
--------
26232635
You can use the parameter ``n`` to represent a shift of n hours.

0 commit comments

Comments
 (0)