Skip to content

DOC: fix SA01,ES01 for pandas.tseries.offsets.SemiMonthBegin #60060

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 2 commits into from
Oct 29, 2024
Merged

DOC: fix SA01,ES01 for pandas.tseries.offsets.SemiMonthBegin #60060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
373bb3a
DOC: fix SA01 for pandas.tseries.offsets.SemiMonthBegin
tuhinsharma121 Oct 16, 2024
da20601
DOC: fix ES01 for pandas.tseries.offsets.SemiMonthBegin
tuhinsharma121 Oct 17, 2024
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 @@ -303,7 +303,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.Second.is_on_offset GL08" \
-i "pandas.tseries.offsets.Second.n GL08" \
-i "pandas.tseries.offsets.Second.normalize GL08" \
-i "pandas.tseries.offsets.SemiMonthBegin SA01" \
-i "pandas.tseries.offsets.SemiMonthBegin.day_of_month GL08" \
-i "pandas.tseries.offsets.SemiMonthBegin.is_on_offset GL08" \
-i "pandas.tseries.offsets.SemiMonthBegin.n GL08" \
Expand Down
11 changes: 11 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 @@ -3371,6 +3371,10 @@ cdef class SemiMonthBegin(SemiMonthOffset):
"""
Two DateOffset's per month repeating on the first day of the month & day_of_month.

This offset moves dates to the first day of the month and an additional specified
day (typically the 15th by default), useful in scenarios where bi-monthly processing
occurs on set days.

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

See Also
--------
tseries.offsets.SemiMonthEnd : Two DateOffset's per month repeating on the last day
of the month & day_of_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, 1)
Expand Down