File tree Expand file tree Collapse file tree 1 file changed +26
-1
lines changed Expand file tree Collapse file tree 1 file changed +26
-1
lines changed Original file line number Diff line number Diff line change @@ -1727,7 +1727,32 @@ def freq(self, value):
1727
1727
is_month_start = _field_accessor (
1728
1728
'is_month_start' ,
1729
1729
'is_month_start' ,
1730
- "Logical indicating if first day of month (defined by frequency)" )
1730
+ """
1731
+ Returns a boolean indicating if the date is the first day of the month.
1732
+
1733
+ Returns
1734
+ -------
1735
+ is_month_start : Series of boolean
1736
+
1737
+ See Also
1738
+ --------
1739
+ is_month_end : Returns a boolean indicating if the date is the last day of the month.
1740
+
1741
+ Examples
1742
+ --------
1743
+ >>> import pandas as pd
1744
+ >>> dates = pd.Series(pd.date_range("2018-02-27", periods = 3))
1745
+ >>> dates
1746
+ 0 2018-02-27
1747
+ 1 2018-02-28
1748
+ 2 2018-03-01
1749
+ dtype: datetime64[ns]
1750
+ >>> dates.dt.is_month_start
1751
+ 0 False
1752
+ 1 False
1753
+ 2 True
1754
+ dtype: bool
1755
+ """ )
1731
1756
is_month_end = _field_accessor (
1732
1757
'is_month_end' ,
1733
1758
'is_month_end' ,
You can’t perform that action at this time.
0 commit comments