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

48779-doc-MonthEnd #49958

Merged
merged 3 commits into from
Nov 30, 2022
Merged

48779-doc-MonthEnd #49958

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82b0015
48779-doc-MonthEnd
natmokval Nov 28, 2022
a95e494
48779-doc-MonthEnd-I
natmokval Nov 29, 2022
c73cdfe
DOC: add example MonthEnd(0)
natmokval Nov 30, 2022
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
19 changes: 18 additions & 1 deletion pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2412,11 +2412,28 @@ cdef class MonthEnd(MonthOffset):
"""
DateOffset of one month end.

MonthEnd goes to the next date which is an end of the month.
To get the end of the current month pass the parameter n equals 0.

See Also
--------
:class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment.

Examples
--------
>>> ts = pd.Timestamp(2022, 1, 1)
>>> ts = pd.Timestamp(2022, 1, 30)
>>> ts + pd.offsets.MonthEnd()
Timestamp('2022-01-31 00:00:00')

>>> ts = pd.Timestamp(2022, 1, 31)
>>> ts + pd.offsets.MonthEnd()
Timestamp('2022-02-28 00:00:00')

If you want to get the end of the current month pass the parameter n equals 0:

>>> ts = pd.Timestamp(2022, 1, 31)
>>> ts + pd.offsets.MonthEnd(0)
Timestamp('2022-01-31 00:00:00')
"""
_period_dtype_code = PeriodDtypeCode.M
_prefix = "M"
Expand Down