BLD: improvements to stats output

catalyst/exchange/exchange_algorithm.py

@@ -671,6 +671,7 @@ class ExchangeTradingAlgorithmLive(ExchangeTradingAlgorithmBase):
         except Exception as e:
             log.warn('unable to calculate performance: {}'.format(e))
 
+        # Writing the stats output
         csv_bytes = None
         try:
             csv_bytes = stats_to_algo_folder(

catalyst/exchange/stats_utils.py

@@ -336,6 +336,20 @@ def stats_to_s3(uri, stats, algo_namespace, recorded_cols=None,
 
 
 def stats_to_algo_folder(stats, algo_namespace, recorded_cols=None):
+    """
+    Saves the performance stats to the algo local folder.
+
+    Parameters
+    ----------
+    stats: list[Object]
+    algo_namespace: str
+    recorded_cols: list[str]
+
+    Returns
+    -------
+    str
+
+    """
     bytes_to_write = get_csv_stats(stats, recorded_cols=recorded_cols)
 
     timestr = time.strftime('%Y%m%d')