Improve documentation for default values.

mlr-org · Jul 20, 2020 · 8c9da37 · 8c9da37
1 parent 93a9e3a
commit 8c9da37
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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.
+#'   `