MAINT clarify docstring parameter

xiaoxiao19 · Dec 8, 2017 · a312434 · a312434
1 parent e7c39e2
commit a312434
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/smac/utils/validate.py b/smac/utils/validate.py
@@ -126,7 +126,9 @@ def validate(self,
         Parameters
         ----------
         output_fn: str
-            path to runhistory to be saved
+            path to runhistory to be saved. if the suffix is not '.json', will
+            be interpreted as directory and filename will be
+            'validated_runhistory.json'
         config_mode: str or list<Configuration>
             string or directly a list of Configuration
             str from [def, inc, def+inc, wallclock_time, cpu_time, all]
@@ -242,7 +244,9 @@ def validate_epm(self,
         Parameters
         ----------
         output_fn: str
-            path to runhistory to be saved
+            path to runhistory to be saved. if the suffix is not '.json', will
+            be interpreted as directory and filename will be
+            'validated_runhistory_EPM.json'
         config_mode: str or list<Configuration>
             string or directly a list of Configuration
             str from [def, inc, def+inc, wallclock_time, cpu_time, all]