Added PeriodIndex examples

Author: DeaMariaLeon

ci/code_checks.sh

@@ -274,16 +274,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         pandas.TimedeltaIndex.as_unit \
         pandas.TimedeltaIndex.to_pytimedelta \
         pandas.TimedeltaIndex.mean \
-        pandas.PeriodIndex.day \
-        pandas.PeriodIndex.dayofweek \
-        pandas.PeriodIndex.day_of_week \
-        pandas.PeriodIndex.dayofyear \
-        pandas.PeriodIndex.day_of_year \
-        pandas.PeriodIndex.days_in_month \
-        pandas.PeriodIndex.daysinmonth \
-        pandas.PeriodIndex.end_time \
-        pandas.PeriodIndex.freqstr \
-        pandas.PeriodIndex.hour \
         pandas.PeriodIndex.is_leap_year \
         pandas.PeriodIndex.minute \
         pandas.PeriodIndex.month \

pandas/_libs/tslibs/period.pyx

@@ -1684,6 +1684,15 @@ cdef class PeriodMixin:
         1   2020-02-29 23:59:59.999999999
         2   2020-03-31 23:59:59.999999999
         dtype: datetime64[ns]
+
+        For PeriodIndex:
+
+        >>> idx = pd.PeriodIndex(["2023-01", "2023-02", "2023-03"], freq="M")
+        >>> idx.end_time
+        DatetimeIndex(['2023-01-31 23:59:59.999999999',
+                       '2023-02-28 23:59:59.999999999',
+                       '2023-03-31 23:59:59.999999999'],
+                       dtype='datetime64[ns]', freq=None)
         """
         return self.to_timestamp(how="end")
 

pandas/core/arrays/datetimelike.py

@@ -829,6 +829,8 @@ def freqstr(self) -> str | None:
 
         Examples
         --------
+        For DatetimeIndex:
+
         >>> idx = pd.DatetimeIndex(["1/1/2020 10:00:00+00:00"], freq="D")
         >>> idx.freqstr
         'D'
@@ -839,6 +841,12 @@ def freqstr(self) -> str | None:
         ...                        freq="infer")
         >>> idx.freqstr
         '2D'
+
+        For PeriodIndex:
+
+        >>> idx = pd.PeriodIndex(["2023-1", "2023-2", "2023-3"], freq="M")
+        >>> idx.freqstr
+        'M'
         """
         if self.freq is None:
             return None

pandas/core/arrays/period.py

@@ -443,6 +443,12 @@ def __arrow_array__(self, type=None):
         "hour",
         """
         The hour of the period.
+
+        Examples
+        --------
+        >>> idx = pd.PeriodIndex(["2023-01-01 10:00", "2023-01-01 11:00"], freq='H')
+        >>> idx.hour
+        Index([10, 11], dtype='int64')
         """,
     )
     minute = _field_accessor(
@@ -510,6 +516,8 @@ def __arrow_array__(self, type=None):
 
         Examples
         --------
+        For Series:
+
         >>> period = pd.period_range('2020-1-1 00:00', '2020-3-1 00:00', freq='M')
         >>> s = pd.Series(period)
         >>> s
@@ -522,6 +530,12 @@ def __arrow_array__(self, type=None):
         1    29
         2    31
         dtype: int64
+
+        For PeriodIndex:
+
+        >>> idx = pd.PeriodIndex(["2023-01", "2023-02", "2023-03"], freq="M")
+        >>> idx.days_in_month   # It can be also entered as `daysinmonth`
+        Index([31, 28, 31], dtype='int64')
         """,
     )
     daysinmonth = days_in_month