diff --git a/pandas/_libs/tslibs/offsets.pyx b/pandas/_libs/tslibs/offsets.pyx index cf02b0cb396bd..17d4e0dd3234b 100644 --- a/pandas/_libs/tslibs/offsets.pyx +++ b/pandas/_libs/tslibs/offsets.pyx @@ -2782,13 +2782,33 @@ cdef class Week(SingleConstructorOffset): Parameters ---------- weekday : int or None, default None - Always generate specific day of week. 0 for Monday. + Always generate specific day of week. + 0 for Monday and 6 for Sunday. - Examples + See Also -------- - >>> ts = pd.Timestamp(2022, 1, 1) - >>> ts + pd.offsets.Week() - Timestamp('2022-01-08 00:00:00') + pd.tseries.offsets.WeekOfMonth : + Describes monthly dates like, the Tuesday of the + 2nd week of each month. + + Examples + --------- + + >>> date_object = pd.Timestamp("2023-01-13") + >>> date_object + Timestamp('2023-01-13 00:00:00') + + >>> date_plus_one_week = date_object + pd.tseries.offsets.Week(n=1) + >>> date_plus_one_week + Timestamp('2023-01-20 00:00:00') + + >>> date_next_monday = date_object + pd.tseries.offsets.Week(weekday=0) + >>> date_next_monday + Timestamp('2023-01-16 00:00:00') + + >>> date_next_sunday = date_object + pd.tseries.offsets.Week(weekday=6) + >>> date_next_sunday + Timestamp('2023-01-15 00:00:00') """ _inc = timedelta(weeks=1)