Skip to content

Commit 5b6997c

Browse files
DOC: fix SA01, ES01 for pandas.tseries.offsets.SemiMonthEnd (#59856)
DOC: fix SA01 for pandas.tseries.offsets.SemiMonthEnd
1 parent 7cebd78 commit 5b6997c

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
364364
-i "pandas.tseries.offsets.SemiMonthBegin.n GL08" \
365365
-i "pandas.tseries.offsets.SemiMonthBegin.normalize GL08" \
366366
-i "pandas.tseries.offsets.SemiMonthBegin.rule_code GL08" \
367-
-i "pandas.tseries.offsets.SemiMonthEnd SA01" \
368367
-i "pandas.tseries.offsets.SemiMonthEnd.day_of_month GL08" \
369368
-i "pandas.tseries.offsets.SemiMonthEnd.is_on_offset GL08" \
370369
-i "pandas.tseries.offsets.SemiMonthEnd.n GL08" \

pandas/_libs/tslibs/offsets.pyx

+12
Original file line numberDiff line numberDiff line change
@@ -3316,6 +3316,11 @@ cdef class SemiMonthEnd(SemiMonthOffset):
33163316
"""
33173317
Two DateOffset's per month repeating on the last day of the month & day_of_month.
33183318
3319+
This offset allows for flexibility in generating date ranges or adjusting dates
3320+
to the end of a month or a specific day in the month, such as the 15th or the last
3321+
day of the month. It is useful for financial or scheduling applications where
3322+
events occur bi-monthly.
3323+
33193324
Attributes
33203325
----------
33213326
n : int, default 1
@@ -3325,6 +3330,13 @@ cdef class SemiMonthEnd(SemiMonthOffset):
33253330
day_of_month : int, {1, 3,...,27}, default 15
33263331
A specific integer for the day of the month.
33273332
3333+
See Also
3334+
--------
3335+
tseries.offsets.SemiMonthBegin : Offset for semi-monthly frequencies, starting at
3336+
the beginning of the month.
3337+
tseries.offsets.MonthEnd : Offset to the last calendar day of the month.
3338+
tseries.offsets.MonthBegin : Offset to the first calendar day of the month.
3339+
33283340
Examples
33293341
--------
33303342
>>> ts = pd.Timestamp(2022, 1, 14)

0 commit comments

Comments
 (0)