Skip to content

DOC: fix ES01,SA01 for pandas.tseries.offsets.CustomBusinessMonthEnd.… #60775

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
Jan 23, 2025
Merged

DOC: fix ES01,SA01 for pandas.tseries.offsets.CustomBusinessMonthEnd.… #60775

Show file tree
Hide file tree
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
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,15 +146,13 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.CustomBusinessMonthBegin PR02" \
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.calendar GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.holidays GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.is_on_offset SA01" \
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.m_offset GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.n GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.normalize GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.weekmask GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthEnd PR02" \
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.calendar GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.holidays GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.is_on_offset SA01" \
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.m_offset GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.n GL08" \
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.normalize GL08" \
Expand Down
13 changes: 13 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 @@ -720,11 +720,24 @@ cdef class BaseOffset:
"""
Return boolean whether a timestamp intersects with this frequency.

This method determines if a given timestamp aligns with the start
of a custom business month, as defined by this offset. It accounts
for custom rules, such as skipping weekends or other non-business days,
and checks whether the provided datetime falls on a valid business day
that marks the beginning of the custom business month.

Parameters
----------
dt : datetime.datetime
Timestamp to check intersections with frequency.

See Also
--------
tseries.offsets.CustomBusinessMonthBegin : Represents the start of a custom
business month.
tseries.offsets.CustomBusinessMonthEnd : Represents the end of a custom
business month.

Examples
--------
>>> ts = pd.Timestamp(2022, 1, 1)
Expand Down
Loading