From 624450a58caa7a01848ae3cb8c106568d11bb024 Mon Sep 17 00:00:00 2001 From: Michel Lang Date: Tue, 21 Jul 2020 20:19:07 +0200 Subject: [PATCH] update docs --- man/Param.Rd | 6 +++++- man/ParamDbl.Rd | 6 +++++- man/ParamFct.Rd | 6 +++++- man/ParamInt.Rd | 6 +++++- man/ParamLgl.Rd | 6 +++++- man/ParamUty.Rd | 6 +++++- 6 files changed, 30 insertions(+), 6 deletions(-) diff --git a/man/Param.Rd b/man/Param.Rd index be6a8a67..570f6916 100644 --- a/man/Param.Rd +++ b/man/Param.Rd @@ -100,7 +100,11 @@ designs nor sampling.} \item{\code{default}}{(\code{any})\cr Default value. Can be from the domain of the parameter or an element of \code{special_vals}. Has value \link{NO_DEF} if no default exists. \code{NULL} can be a -valid default.} +valid default. +The value has no effect on \code{ParamSet$values} or the behavior of +\code{ParamSet$check()}, \verb{$test()} or \verb{$assert()}. +The \code{default} is intended to be used for documentation purposes. +`} \item{\code{tags}}{(\code{character()})\cr Arbitrary tags to group and subset parameters. Some tags serve a special diff --git a/man/ParamDbl.Rd b/man/ParamDbl.Rd index 0deb7499..cd2366c3 100644 --- a/man/ParamDbl.Rd +++ b/man/ParamDbl.Rd @@ -120,7 +120,11 @@ designs nor sampling.} \item{\code{default}}{(\code{any})\cr Default value. Can be from the domain of the parameter or an element of \code{special_vals}. Has value \link{NO_DEF} if no default exists. \code{NULL} can be a -valid default.} +valid default. +The value has no effect on \code{ParamSet$values} or the behavior of +\code{ParamSet$check()}, \verb{$test()} or \verb{$assert()}. +The \code{default} is intended to be used for documentation purposes. +`} \item{\code{tags}}{(\code{character()})\cr Arbitrary tags to group and subset parameters. Some tags serve a special diff --git a/man/ParamFct.Rd b/man/ParamFct.Rd index 9debd16b..cca79fcd 100644 --- a/man/ParamFct.Rd +++ b/man/ParamFct.Rd @@ -110,7 +110,11 @@ Set of allowed levels.} \item{\code{default}}{(\code{any})\cr Default value. Can be from the domain of the parameter or an element of \code{special_vals}. Has value \link{NO_DEF} if no default exists. \code{NULL} can be a -valid default.} +valid default. +The value has no effect on \code{ParamSet$values} or the behavior of +\code{ParamSet$check()}, \verb{$test()} or \verb{$assert()}. +The \code{default} is intended to be used for documentation purposes. +`} \item{\code{special_vals}}{(\code{list()})\cr Arbitrary special values this parameter is allowed to take, to make it diff --git a/man/ParamInt.Rd b/man/ParamInt.Rd index e76453d2..6edfec28 100644 --- a/man/ParamInt.Rd +++ b/man/ParamInt.Rd @@ -125,7 +125,11 @@ designs nor sampling.} \item{\code{default}}{(\code{any})\cr Default value. Can be from the domain of the parameter or an element of \code{special_vals}. Has value \link{NO_DEF} if no default exists. \code{NULL} can be a -valid default.} +valid default. +The value has no effect on \code{ParamSet$values} or the behavior of +\code{ParamSet$check()}, \verb{$test()} or \verb{$assert()}. +The \code{default} is intended to be used for documentation purposes. +`} \item{\code{tags}}{(\code{character()})\cr Arbitrary tags to group and subset parameters. Some tags serve a special diff --git a/man/ParamLgl.Rd b/man/ParamLgl.Rd index 55f5879d..2f665b19 100644 --- a/man/ParamLgl.Rd +++ b/man/ParamLgl.Rd @@ -102,7 +102,11 @@ designs nor sampling.} \item{\code{default}}{(\code{any})\cr Default value. Can be from the domain of the parameter or an element of \code{special_vals}. Has value \link{NO_DEF} if no default exists. \code{NULL} can be a -valid default.} +valid default. +The value has no effect on \code{ParamSet$values} or the behavior of +\code{ParamSet$check()}, \verb{$test()} or \verb{$assert()}. +The \code{default} is intended to be used for documentation purposes. +`} \item{\code{tags}}{(\code{character()})\cr Arbitrary tags to group and subset parameters. Some tags serve a special diff --git a/man/ParamUty.Rd b/man/ParamUty.Rd index 5c8e465f..e9f48f42 100644 --- a/man/ParamUty.Rd +++ b/man/ParamUty.Rd @@ -104,7 +104,11 @@ Identifier of the object.} \item{\code{default}}{(\code{any})\cr Default value. Can be from the domain of the parameter or an element of \code{special_vals}. Has value \link{NO_DEF} if no default exists. \code{NULL} can be a -valid default.} +valid default. +The value has no effect on \code{ParamSet$values} or the behavior of +\code{ParamSet$check()}, \verb{$test()} or \verb{$assert()}. +The \code{default} is intended to be used for documentation purposes. +`} \item{\code{tags}}{(\code{character()})\cr Arbitrary tags to group and subset parameters. Some tags serve a special