better summary in docstring

pmlmodelling · Jun 13, 2024 · 08e343f · 08e343f
1 parent ad3f398
commit 08e343f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/ecoval/__init__.py b/ecoval/__init__.py
@@ -384,7 +384,7 @@ def compare(model_dict=None):
 def validate(title="Automated model evaluation", author=None, variables = "all", r_warnings = False, build = "html", model = None):
     # docstring
     """
-    This function will run the model evaluation for all of the available datasets.
+    Run the model evaluation for all of the available datasets, and generate a validation report.
 
     Parameters
     ----------
@@ -998,7 +998,7 @@ def make_header_bold(x):
 
 def rebuild(build = None):
     """
-    This function will rebuild the book.
+    Rebuild the validation report after modifying notebooks.
     Use this if you have modified the notebooks generated and want to create a validation report.
 
     Parameters

diff --git a/ecoval/helpers.py b/ecoval/helpers.py
@@ -12,7 +12,8 @@ def is_int(s):
 
 def matchup_starting_point(ff, val_dir = None):
     """
-    A function to create a string that can be used to call ecoval.matchup.
+    Create a ecoval.matchup call based on the available validation data.
+    This function will identify the domain based on the model grid, identify available data, and then generate a maximal call to ecoval.matchup that can be stripped down to your needs.
 
     Parameters
     ----------