better docstring for matchup_starting_point

pmlmodelling · Jun 13, 2024 · ad3f398 · ad3f398
1 parent 9d54f67
commit ad3f398
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/ecoval/helpers.py b/ecoval/helpers.py
@@ -12,12 +12,14 @@ 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.
+
     Parameters
     ----------
     ff : str
         Path to the netcdf file
     val_dir : str
-        Path to the validation data directory
+        Path to the validation data directory. This only needs to be used outside Plymouth Marine Laboratory.
     Returns
     -------
     str