Skip to content
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

DOC: add missing parameters n\normalize\offset to offsets classes #54635

Merged
merged 1 commit into from
Aug 21, 2023
Merged

DOC: add missing parameters n\normalize\offset to offsets classes #54635

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
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 @@ -1621,6 +1621,8 @@ cdef class BusinessDay(BusinessMixin):
The number of days represented.
normalize : bool, default False
Normalize start/end dates to midnight.
offset : timedelta, default timedelta(0)
Time offset to apply.

Examples
--------
Expand Down Expand Up @@ -3148,6 +3150,10 @@ cdef class Week(SingleConstructorOffset):

Parameters
----------
n : int, default 1
The number of weeks represented.
normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
weekday : int or None, default None
Always generate specific day of week.
0 for Monday and 6 for Sunday.
Expand Down Expand Up @@ -3398,6 +3404,9 @@ cdef class LastWeekOfMonth(WeekOfMonthMixin):
Parameters
----------
n : int, default 1
The number of months represented.
normalize : bool, default False
Normalize start/end dates to midnight before generating date range.
weekday : int {0, 1, ..., 6}, default 0
A specific integer for the day of the week.

Expand Down Expand Up @@ -4150,6 +4159,8 @@ cdef class CustomBusinessHour(BusinessHour):
Start time of your custom business hour in 24h format.
end : str, time, or list of str/time, default: "17:00"
End time of your custom business hour in 24h format.
offset : timedelta, default timedelta(0)
Time offset to apply.

Examples
--------
Expand Down