better docstring for depth_profile

pmlmodelling · Feb 10, 2025 · 2a84c3e · 2a84c3e
1 parent 7692d8b
commit 2a84c3e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/ecoval/differences.py b/ecoval/differences.py
@@ -264,7 +264,8 @@ def compare_simulations(
     phenology : dict
         A dictionary of variables to compare phenology
     depth_profile : dict
-        A dictionary of variables to compare depth profiles
+        A dictionary of variables to compare depth profiles.
+        Note: this is only of real use for concentrations based variables. It will calculate the average depth weighted by the concentration.
     start : int
         The start year
     end : int