Skip to content

DOC: update the pandas.DateTimeArrayMixin.is_month_start docstring #23051

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.

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

Merged
28 changes: 28 additions & 0 deletions pandas/core/arrays/datetimes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1011,6 +1011,34 @@ def date(self):
'is_month_start',
'is_month_start',
"Logical indicating if first day of month (defined by frequency)")
"""
Indicates whether the date is the first day of the month.

Returns
-------
Series of bool
Series of boolean values indicating whether the date is the first
day of the month

See Also
--------
is_month_end : Return a boolean indicating whether the date is
the last day of the month.

Examples
--------
>>> s = pd.Series(pd.date_range("2018-02-27", periods=3))
>>> s
0 2018-02-27
1 2018-02-28
2 2018-03-01
dtype: datetime64[ns]
>>> s.dt.is_month_start
0 False
1 False
2 True
dtype: bool
"""
is_month_end = _field_accessor(
'is_month_end',
'is_month_end',
Expand Down