Update datetimelike.py

Author: AnonToky

pandas/core/indexes/datetimelike.py

@@ -36,7 +36,9 @@
     NullFrequencyError,
 )
 from pandas.util._decorators import (
+    Appender,
     cache_readonly,
+    doc,
 )
 
 from pandas.core.dtypes.common import (
@@ -55,10 +57,12 @@
     PeriodArray,
     TimedeltaArray,
 )
+from pandas.core.arrays.datetimelike import DatetimeLikeArrayMixin
 import pandas.core.common as com
 import pandas.core.indexes.base as ibase
 from pandas.core.indexes.base import (
     Index,
+    _index_shared_docs,
 )
 from pandas.core.indexes.extension import NDArrayBackedExtensionIndex
 from pandas.core.indexes.range import RangeIndex
@@ -103,6 +107,21 @@ def mean(self, *, skipna: bool = True, axis: int | None = 0):
         -------
         scalar
             Timestamp or Timedelta.
+
+        See Also
+        --------
+        numpy.ndarray.mean : Returns the average of the array elements.
+        Series.mean : Return the mean value in a Series.
+
+        Examples
+        --------
+        >>> idx = pd.date_range('2023-01-01', periods=3)
+        >>> idx.mean()
+        Timestamp('2023-01-02 00:00:00')
+
+        >>> idx = pd.to_timedelta([1, 2, 3], unit='D')
+        >>> idx.mean()
+        Timedelta('2 days 00:00:00')
         """
         return self._data.mean(skipna=skipna, axis=axis)
 
@@ -149,6 +168,18 @@ def asi8(self) -> npt.NDArray[np.int64]:
     def freqstr(self) -> str:
         """
         Return the frequency string if it is set, otherwise None.
+
+        See Also
+        --------
+        DatetimeIndex.freq : Return the frequency object if it is set, otherwise None.
+        DatetimeIndex.inferred_freq : Tries to return a string representing a frequency
+            guess generated by infer_freq.
+
+        Examples
+        --------
+        >>> idx = pd.date_range('2023-01-01', periods=3, freq='D')
+        >>> idx.freqstr
+        'D'
         """
         from pandas import PeriodIndex
 
@@ -591,6 +622,17 @@ def inferred_freq(self) -> str | None:
         Returns
         -------
         str or None
+
+        See Also
+        --------
+        DatetimeIndex.freq : Return the frequency object if it is set, otherwise None.
+        DatetimeIndex.freqstr : Return the frequency string if it is set, otherwise None.
+
+        Examples
+        --------
+        >>> idx = pd.DatetimeIndex(['2018-01-01', '2018-01-03', '2018-01-05'])
+        >>> idx.inferred_freq
+        '2D'
         """
         return self._data.inferred_freq