TODO: unit tests for simil days

[talweg.git] / pkg / R / F_Zero.R

diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R
index ac970c4..2c9a7b7 100644 (file)
--- a/pkg/R/F_Zero.R
+++ b/pkg/R/F_Zero.R
@@ -1,6 +1,11 @@
 #' Zero Forecaster
 #'
-#' Return 0 (and then adjust). Inherits \code{\link{Forecaster}}
+#' Flat prediction: always forecast a serie of zeros.
+#' This serie is then adjusted using the ".pjump" function (see \code{Forecaster} class).
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Zero
 #'
 ZeroForecaster = R6::R6Class("ZeroForecaster",
        inherit = Forecaster,