Skip to content

Commit ecf0887

Browse files
committed
doctring rewritten
1 parent 4131149 commit ecf0887

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

pandas/core/indexes/datetimes.py

+26-1
Original file line numberDiff line numberDiff line change
@@ -1731,7 +1731,32 @@ def freq(self, value):
17311731
is_month_end = _field_accessor(
17321732
'is_month_end',
17331733
'is_month_end',
1734-
"Logical indicating if last day of month (defined by frequency)")
1734+
"""
1735+
Return a boolean indicating if the date is the last day of the month.
1736+
1737+
Returns
1738+
-------
1739+
is_month_end : Series of boolean
1740+
1741+
See Also
1742+
--------
1743+
is_month_start : Returns a boolean indicating if the date is the first day
1744+
of the month.
1745+
1746+
Examples
1747+
--------
1748+
>>> dates = pd.Series(pd.date_range("2018-02-27", periods=3))
1749+
>>> dates
1750+
0 2018-02-27
1751+
1 2018-02-28
1752+
2 2018-03-01
1753+
dtype: datetime64[ns]
1754+
>>> dates.dt.is_month_start
1755+
0 False
1756+
1 True
1757+
2 False
1758+
dtype: bool
1759+
""")
17351760
is_quarter_start = _field_accessor(
17361761
'is_quarter_start',
17371762
'is_quarter_start',

0 commit comments

Comments
 (0)