From 8c9da3709dc9800606cf1279f2d3ad3ccbab81f2 Mon Sep 17 00:00:00 2001 From: Jakob Richter Date: Mon, 20 Jul 2020 10:28:09 +0200 Subject: [PATCH] Improve documentation for default values. --- man-roxygen/param_default.R | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/man-roxygen/param_default.R b/man-roxygen/param_default.R index fd4a5f78..ffc0d9a5 100644 --- a/man-roxygen/param_default.R +++ b/man-roxygen/param_default.R @@ -2,3 +2,7 @@ #' Default value. Can be from the domain of the parameter or an element of #' `special_vals`. Has value [NO_DEF] if no default exists. `NULL` can be a #' valid default. +#' The value has no effect on `ParamSet$values` or the behavior of +#' `ParamSet$check()`, `$test()` or `$assert()`. +#' The `default` is intended to be used for documentation purposes. +#' `