Skip to content

DOC: Added constructor parameters to DateOffset docstring for API consistency #52431 #61363

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

DOC: Added constructor parameters to DateOffset docstring for API consistency #52431 #61363

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
facecf8
DOC: Added constructor parameters to DateOffset docstring for API con…
sainivasrangaraju Apr 27, 2025
90551b5
Started the doc with the summary line already existing
sainivasrangaraju Apr 27, 2025
0329062
Removed blank spaces and tabs in the documentation
sainivasrangaraju Apr 27, 2025
aa2e35f
Used backticks for kwds to remove warning
sainivasrangaraju Apr 27, 2025
6ec1b33
Merge branch 'main' into sainivas-pandas
sainivas-99 Apr 28, 2025
52a493b
Merge branch 'main' into sainivas-pandas
sainivas-99 Apr 29, 2025
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
4 changes: 4 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 @@ -1639,6 +1639,10 @@ class DateOffset(RelativeDeltaOffset, metaclass=OffsetMeta):
"""
Standard kind of date increment used for a date range.

class pandas.tseries.offsets.DateOffset(
n = 1, normalize = False, weekday = 0, ``**kwds``
)

Works exactly like the keyword argument form of relativedelta.
Note that the positional argument form of relativedelta is not
supported. Use of the keyword n is discouraged-- you would be better
Expand Down
Loading