From cb40db35c4b3782bb9ce98e6171b48e515ee4ca5 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Mon, 28 Feb 2022 16:08:38 +0100
Subject: [PATCH] docs(man): review text of the '$CemaNeigeLayers' element in
the 'value' section of 'RunModel_CemaNeige*'
---
man/RunModel_CemaNeige.Rd | 2 +-
man/RunModel_CemaNeigeGR4H.Rd | 4 ++--
man/RunModel_CemaNeigeGR5H.Rd | 1 +
man/RunModel_CemaNeigeGR5J.Rd | 2 +-
man/RunModel_CemaNeigeGR6J.Rd | 2 +-
5 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd
index 685cb2a6..af3b6040 100644
--- a/man/RunModel_CemaNeige.Rd
+++ b/man/RunModel_CemaNeige.Rd
@@ -37,7 +37,7 @@ RunModel_CemaNeige(InputsModel, RunOptions, Param)
[list] containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
- \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
+ \emph{$CemaNeigeLayers} \tab [list] CemaNeige outputs (1 element per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/time step] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/time step] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
diff --git a/man/RunModel_CemaNeigeGR4H.Rd b/man/RunModel_CemaNeigeGR4H.Rd
index 1e876ee0..5a82a268 100644
--- a/man/RunModel_CemaNeigeGR4H.Rd
+++ b/man/RunModel_CemaNeigeGR4H.Rd
@@ -59,10 +59,10 @@ RunModel_CemaNeigeGR4H(InputsModel, RunOptions, Param)
\emph{$QR } \tab [numeric] series of routing store outflow (Qr) [mm/h] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (Qd) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [mm/h] \cr
- \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
+ \emph{$CemaNeigeLayers} \tab [list] CemaNeige outputs (1 element per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/h] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent)[mm] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent)[mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState} \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/h] \cr
diff --git a/man/RunModel_CemaNeigeGR5H.Rd b/man/RunModel_CemaNeigeGR5H.Rd
index 3c45c615..80633662 100644
--- a/man/RunModel_CemaNeigeGR5H.Rd
+++ b/man/RunModel_CemaNeigeGR5H.Rd
@@ -63,6 +63,7 @@ RunModel_CemaNeigeGR5H(InputsModel, RunOptions, Param)
\emph{$QR } \tab [numeric] series of routing store outflow (Qr) [mm/h] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH after exchange (Qd) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [mm/h] \cr
+ \emph{$CemaNeigeLayers} \tab [list] CemaNeige outputs (1 element per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/h] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd
index 2ca146db..772bb7ce 100644
--- a/man/RunModel_CemaNeigeGR5J.Rd
+++ b/man/RunModel_CemaNeigeGR5J.Rd
@@ -60,7 +60,7 @@ RunModel_CemaNeigeGR5J(InputsModel, RunOptions, Param)
\emph{$QR } \tab [numeric] series of routing store outflow (Qr) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH after exchange (Qd) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [mm/d] \cr
- \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
+ \emph{$CemaNeigeLayers} \tab [list] CemaNeige outputs (1 element per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd
index 84c83e82..88fbf5e0 100644
--- a/man/RunModel_CemaNeigeGR6J.Rd
+++ b/man/RunModel_CemaNeigeGR6J.Rd
@@ -63,7 +63,7 @@ RunModel_CemaNeigeGR6J(InputsModel, RunOptions, Param)
\emph{$Exp } \tab [numeric] series of exponential store level (negative) (R2) [mm] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (Qd) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [mm/d] \cr
- \emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
+ \emph{$CemaNeigeLayers} \tab [list] CemaNeige outputs (1 element per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [mm] \cr
--
GitLab