DOC: Adding parameters to frequencies, offsets (issue pandas-dev#2916)

karmel · Apr 22, 2013 · d385d25 · d385d25
1 parent c21706c
commit d385d25
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/pandas/tseries/frequencies.py b/pandas/tseries/frequencies.py
@@ -746,6 +746,7 @@ def infer_freq(index, warn=True):
     Parameters
     ----------
     index : DatetimeIndex
+    warn : boolean, default True
 
     Returns
     -------

diff --git a/pandas/tseries/offsets.py b/pandas/tseries/offsets.py
@@ -1197,13 +1197,16 @@ def generate_range(start=None, end=None, periods=None,
     start : datetime (default None)
     end : datetime (default None)
     periods : int, optional
+    time_rule : (legacy) name of DateOffset object to be used, optional
+        Corresponds with names expected by tseries.frequencies.get_offset        
 
     Note
     ----
     * This method is faster for generating weekdays than dateutil.rrule
     * At least two of (start, end, periods) must be specified.
     * If both start and end are specified, the returned dates will
     satisfy start <= date <= end.
+    * If both time_rule and offset are specified, time_rule supersedes offset.
 
     Returns
     -------