MAINT specify docstring on save_results in validate

xiaoxiao19 · Dec 13, 2017 · e7e002e · e7e002e
1 parent a312434
commit e7e002e
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/smac/utils/validate.py b/smac/utils/validate.py
@@ -90,9 +90,12 @@ def _save_results(self, rh: RunHistory, output_fn, backup_fn=None):
         rh: RunHistory
             runhistory to save
         output_fn: str
-            filename to save history to
+            if ends on '.json': filename to save history to
+            else: directory to save runhistory to (filename is backup_fn)
         backup_fn: str
-            if output_fn is not a file, treating as dir and append this filename
+            if output_fn does not end on '.json', treat output_fn as dir and
+            append backup_fn as filename (if output_fn ends on '.json', this
+            argument is ignored)
         """
         if output_fn == "":
             self.logger.info("No output specified, validated runhistory not saved.")