From 60db76128b2808979f57b1eb02192bd867524ab4 Mon Sep 17 00:00:00 2001
From: David <david.dorchies@inrae.fr>
Date: Wed, 27 Mar 2024 15:08:39 +0100
Subject: [PATCH] docs(RunModel.InputsModel): detail water over-abstraction

Refs #144
---
 R/RunModel.InputsModel.R | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/R/RunModel.InputsModel.R b/R/RunModel.InputsModel.R
index 3f68709..1c41fc9 100644
--- a/R/RunModel.InputsModel.R
+++ b/R/RunModel.InputsModel.R
@@ -7,7 +7,9 @@
 #'
 #' - an item `$Qsim_m3` storing the simulated discharge series in m3/s
 #' - an item `$Qover_m3` storing the volumes of over abstraction which occurs
-#' when `RunModel_Lag` warns for negative simulated flows.
+#' when `RunModel_Lag` warns for negative simulated flows. The latter reflects the volume
+#' that was planned to be drawn from the sub-basin but could not be drawn because
+#' of the lack of water.
 #'
 #' @inheritParams airGR::RunModel
 #' @param x \[object of class \emph{InputsModel}\] see [airGR::CreateInputsModel] for details
-- 
GitLab