Add full docstring to replicate_cycle

Author: xylar

mpas_analysis/sea_ice/timeseries.py

@@ -350,6 +350,34 @@ def seaice_timeseries(config, streamMap=None, variableMap=None):
 
 
 def replicate_cycle(ds, dsToReplicate, calendar):
+    """
+    Replicates a periodic time series `dsToReplicate` to cover the timeframe
+    of the dataset `ds`.
+
+    Parameters
+    ----------
+    ds : dataset used to find the start and end time of the replicated cycle
+
+    dsToReplicate : dataset to replicate.  The period of the cycle is the
+        length of dsToReplicate plus the time between the first two time
+        values (typically one year total).
+
+    calendar : {'gregorian', 'gregorian_noleap'}
+        The name of one of the calendars supported by MPAS cores
+
+    Returns:
+    --------
+    dsShift : a cyclicly repeated version of `dsToReplicte` covering the range
+        of time of `ds`.
+
+    Authors
+    -------
+    Xylar Asay-Davis, Milena Veneziani
+
+    Last Modified
+    -------------
+    02/22/2017
+    """
     dsStartTime = days_to_datetime(ds.Time.min(), calendar=calendar)
     dsEndTime = days_to_datetime(ds.Time.max(), calendar=calendar)
     repStartTime = days_to_datetime(dsToReplicate.Time.min(),