Skip to content

Commit be538ef

Browse files
DOC: fix ES01,SA01 for pandas.tseries.offsets.CustomBusinessMonthEnd.… (#60775)
DOC: fix ES01,SA01 for pandas.tseries.offsets.CustomBusinessMonthEnd.is_on_offset and pandas.tseries.offsets.CustomBusinessMonthBegin.is_on_offset
1 parent 222d7c7 commit be538ef

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -146,15 +146,13 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
146146
-i "pandas.tseries.offsets.CustomBusinessMonthBegin PR02" \
147147
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.calendar GL08" \
148148
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.holidays GL08" \
149-
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.is_on_offset SA01" \
150149
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.m_offset GL08" \
151150
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.n GL08" \
152151
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.normalize GL08" \
153152
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.weekmask GL08" \
154153
-i "pandas.tseries.offsets.CustomBusinessMonthEnd PR02" \
155154
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.calendar GL08" \
156155
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.holidays GL08" \
157-
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.is_on_offset SA01" \
158156
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.m_offset GL08" \
159157
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.n GL08" \
160158
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.normalize GL08" \

pandas/_libs/tslibs/offsets.pyx

+13
Original file line numberDiff line numberDiff line change
@@ -720,11 +720,24 @@ cdef class BaseOffset:
720720
"""
721721
Return boolean whether a timestamp intersects with this frequency.
722722

723+
This method determines if a given timestamp aligns with the start
724+
of a custom business month, as defined by this offset. It accounts
725+
for custom rules, such as skipping weekends or other non-business days,
726+
and checks whether the provided datetime falls on a valid business day
727+
that marks the beginning of the custom business month.
728+
723729
Parameters
724730
----------
725731
dt : datetime.datetime
726732
Timestamp to check intersections with frequency.
727733

734+
See Also
735+
--------
736+
tseries.offsets.CustomBusinessMonthBegin : Represents the start of a custom
737+
business month.
738+
tseries.offsets.CustomBusinessMonthEnd : Represents the end of a custom
739+
business month.
740+
728741
Examples
729742
--------
730743
>>> ts = pd.Timestamp(2022, 1, 1)

0 commit comments

Comments
 (0)