DOC: infer_freq, inferred_freq

jnmclarty · jnmclarty · commit 6d98bc9c5096 · 2015-05-03T11:45:16.000-04:00
diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -158,6 +158,7 @@ Top-level dealing with datetimelike
    bdate_range
    period_range
    timedelta_range
+   infer_freq
 
 Top-level evaluation
 ~~~~~~~~~~~~~~~~~~~~
@@ -1364,6 +1365,7 @@ Time/Date Components
    DatetimeIndex.is_quarter_end
    DatetimeIndex.is_year_start
    DatetimeIndex.is_year_end
+   DatetimeIndex.inferred_freq
 
 Selecting
 ~~~~~~~~~
diff --git a/pandas/tseries/base.py b/pandas/tseries/base.py
@@ -79,6 +79,11 @@ def freqstr(self):
 
     @cache_readonly
     def inferred_freq(self):
+        """ 
+        Trys to return a string representing a frequency guess, 
+        generated by infer_freq.  Returns None if it can't autodetect the 
+        frequency.
+        """
         try:
             return infer_freq(self)
         except ValueError:
