Skip to content

DOC: fix SA01, ES01 for pandas.tseries.offsets.SemiMonthEnd #59856

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
Sep 25, 2024
Merged

DOC: fix SA01, ES01 for pandas.tseries.offsets.SemiMonthEnd #59856

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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.SemiMonthBegin.n GL08" \
-i "pandas.tseries.offsets.SemiMonthBegin.normalize GL08" \
-i "pandas.tseries.offsets.SemiMonthBegin.rule_code GL08" \
-i "pandas.tseries.offsets.SemiMonthEnd SA01" \
-i "pandas.tseries.offsets.SemiMonthEnd.day_of_month GL08" \
-i "pandas.tseries.offsets.SemiMonthEnd.is_on_offset GL08" \
-i "pandas.tseries.offsets.SemiMonthEnd.n GL08" \
Expand Down
12 changes: 12 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 @@ -3316,6 +3316,11 @@ cdef class SemiMonthEnd(SemiMonthOffset):
"""
Two DateOffset's per month repeating on the last day of the month & day_of_month.

This offset allows for flexibility in generating date ranges or adjusting dates
to the end of a month or a specific day in the month, such as the 15th or the last
day of the month. It is useful for financial or scheduling applications where
events occur bi-monthly.

Attributes
----------
n : int, default 1
Expand All @@ -3325,6 +3330,13 @@ cdef class SemiMonthEnd(SemiMonthOffset):
day_of_month : int, {1, 3,...,27}, default 15
A specific integer for the day of the month.

See Also
--------
tseries.offsets.SemiMonthBegin : Offset for semi-monthly frequencies, starting at
the beginning of the month.
tseries.offsets.MonthEnd : Offset to the last calendar day of the month.
tseries.offsets.MonthBegin : Offset to the first calendar day of the month.

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