Skip to content

Commit

Permalink
DOC: fix SA01,ES01 for pandas.tseries.offsets.WeekOfMonth (#59834)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Sep 18, 2024
1 parent 8b1b211 commit a851438
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.Week.n GL08" \
-i "pandas.tseries.offsets.Week.normalize GL08" \
-i "pandas.tseries.offsets.Week.weekday GL08" \
-i "pandas.tseries.offsets.WeekOfMonth SA01" \
-i "pandas.tseries.offsets.WeekOfMonth.is_on_offset GL08" \
-i "pandas.tseries.offsets.WeekOfMonth.n GL08" \
-i "pandas.tseries.offsets.WeekOfMonth.normalize GL08" \
Expand Down
11 changes: 11 additions & 0 deletions pandas/_libs/tslibs/offsets.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -3582,6 +3582,11 @@ cdef class WeekOfMonth(WeekOfMonthMixin):
"""
Describes monthly dates like "the Tuesday of the 2nd week of each month".
This offset allows for generating or adjusting dates by specifying
a particular week and weekday within a month. The week is zero-indexed,
where 0 corresponds to the first week of the month, and weekday follows
a Monday=0 convention.
Attributes
----------
n : int, default 1
Expand All @@ -3602,6 +3607,12 @@ cdef class WeekOfMonth(WeekOfMonthMixin):
- 5 is Saturday
- 6 is Sunday.
See Also
--------
offsets.Week : Describes weekly frequency adjustments.
offsets.MonthEnd : Describes month-end frequency adjustments.
date_range : Generates a range of dates based on a specific frequency.
Examples
--------
>>> ts = pd.Timestamp(2022, 1, 1)
Expand Down

0 comments on commit a851438

Please sign in to comment.