Skip to content

Commit 433b140

Browse files
DOC: Fix PR02,SA01 for pandas.tseries.offsets.CustomBusinessHour (#63952)
1 parent 9f238ba commit 433b140

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

ci/code_checks.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
6969
MSG='Validate Docstrings' ; echo "$MSG"
7070
"$BASE_DIR"/scripts/validate_docstrings.py \
7171
--format=actions \
72-
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
73-
-i "pandas.tseries.offsets.CustomBusinessHour PR02,SA01" # There should be no backslash in the final line, please keep this comment in the last ignored function
72+
-i ES01 `# For now it is ok if docstrings are missing the extended summary`
7473

7574
RET=$(($RET + $?)) ; echo $MSG "DONE"
7675

doc/source/reference/offset_frequency.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ Properties
201201
CustomBusinessHour.holidays
202202
CustomBusinessHour.start
203203
CustomBusinessHour.end
204+
CustomBusinessHour.offset
204205

205206
Methods
206207
~~~~~~~

pandas/_libs/tslibs/offsets.pyx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6499,7 +6499,7 @@ cdef class CustomBusinessHour(BusinessHour):
64996499
65006500
In CustomBusinessHour we can use custom weekmask, holidays, and calendar.
65016501
6502-
Parameters
6502+
Attributes
65036503
----------
65046504
n : int, default 1
65056505
The number of hours represented.
@@ -6519,6 +6519,13 @@ cdef class CustomBusinessHour(BusinessHour):
65196519
offset : timedelta, default timedelta(0)
65206520
Time offset to apply.
65216521
6522+
See Also
6523+
--------
6524+
:class:`~pandas.tseries.offsets.BusinessHour` :
6525+
DateOffset subclass representing possibly n business hours.
6526+
:class:`~pandas.tseries.offsets.CustomBusinessDay` :
6527+
DateOffset subclass representing custom business days.
6528+
65226529
Examples
65236530
--------
65246531
In the example below the default parameters give the next business hour.

0 commit comments

Comments
 (0)