Skip to content

Commit 40b5610

Browse files
DOC: fix SA01,ES01 for pandas.tseries.offsets.SemiMonthBegin (#60060)
* DOC: fix SA01 for pandas.tseries.offsets.SemiMonthBegin * DOC: fix ES01 for pandas.tseries.offsets.SemiMonthBegin
1 parent b9c6fa8 commit 40b5610

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
292292
-i "pandas.tseries.offsets.Second.is_on_offset GL08" \
293293
-i "pandas.tseries.offsets.Second.n GL08" \
294294
-i "pandas.tseries.offsets.Second.normalize GL08" \
295-
-i "pandas.tseries.offsets.SemiMonthBegin SA01" \
296295
-i "pandas.tseries.offsets.SemiMonthBegin.day_of_month GL08" \
297296
-i "pandas.tseries.offsets.SemiMonthBegin.is_on_offset GL08" \
298297
-i "pandas.tseries.offsets.SemiMonthBegin.n GL08" \

pandas/_libs/tslibs/offsets.pyx

+11
Original file line numberDiff line numberDiff line change
@@ -3371,6 +3371,10 @@ cdef class SemiMonthBegin(SemiMonthOffset):
33713371
"""
33723372
Two DateOffset's per month repeating on the first day of the month & day_of_month.
33733373
3374+
This offset moves dates to the first day of the month and an additional specified
3375+
day (typically the 15th by default), useful in scenarios where bi-monthly processing
3376+
occurs on set days.
3377+
33743378
Attributes
33753379
----------
33763380
n : int, default 1
@@ -3380,6 +3384,13 @@ cdef class SemiMonthBegin(SemiMonthOffset):
33803384
day_of_month : int, {1, 3,...,27}, default 15
33813385
A specific integer for the day of the month.
33823386
3387+
See Also
3388+
--------
3389+
tseries.offsets.SemiMonthEnd : Two DateOffset's per month repeating on the last day
3390+
of the month & day_of_month.
3391+
tseries.offsets.MonthEnd : Offset to the last calendar day of the month.
3392+
tseries.offsets.MonthBegin : Offset to the first calendar day of the month.
3393+
33833394
Examples
33843395
--------
33853396
>>> ts = pd.Timestamp(2022, 1, 1)

0 commit comments

Comments
 (0)