From 08e343f6c4ae11039d5e99485d044944fa567c39 Mon Sep 17 00:00:00 2001 From: Robert Wilson Date: Thu, 13 Jun 2024 11:55:08 +0100 Subject: [PATCH] better summary in docstring --- ecoval/__init__.py | 4 ++-- ecoval/helpers.py | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/ecoval/__init__.py b/ecoval/__init__.py index 3dcfff5..75250f8 100755 --- 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 index 89ab86f..15fb94f 100644 --- 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 ----------