Skip to content

Commit a851438

Browse files
DOC: fix SA01,ES01 for pandas.tseries.offsets.WeekOfMonth (pandas-dev#59834)
1 parent 8b1b211 commit a851438

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
@@ -383,7 +383,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
383383
-i "pandas.tseries.offsets.Week.n GL08" \
384384
-i "pandas.tseries.offsets.Week.normalize GL08" \
385385
-i "pandas.tseries.offsets.Week.weekday GL08" \
386-
-i "pandas.tseries.offsets.WeekOfMonth SA01" \
387386
-i "pandas.tseries.offsets.WeekOfMonth.is_on_offset GL08" \
388387
-i "pandas.tseries.offsets.WeekOfMonth.n GL08" \
389388
-i "pandas.tseries.offsets.WeekOfMonth.normalize GL08" \

pandas/_libs/tslibs/offsets.pyx

+11
Original file line numberDiff line numberDiff line change
@@ -3582,6 +3582,11 @@ cdef class WeekOfMonth(WeekOfMonthMixin):
35823582
"""
35833583
Describes monthly dates like "the Tuesday of the 2nd week of each month".
35843584
3585+
This offset allows for generating or adjusting dates by specifying
3586+
a particular week and weekday within a month. The week is zero-indexed,
3587+
where 0 corresponds to the first week of the month, and weekday follows
3588+
a Monday=0 convention.
3589+
35853590
Attributes
35863591
----------
35873592
n : int, default 1
@@ -3602,6 +3607,12 @@ cdef class WeekOfMonth(WeekOfMonthMixin):
36023607
- 5 is Saturday
36033608
- 6 is Sunday.
36043609
3610+
See Also
3611+
--------
3612+
offsets.Week : Describes weekly frequency adjustments.
3613+
offsets.MonthEnd : Describes month-end frequency adjustments.
3614+
date_range : Generates a range of dates based on a specific frequency.
3615+
36053616
Examples
36063617
--------
36073618
>>> ts = pd.Timestamp(2022, 1, 1)

0 commit comments

Comments
 (0)