Merge pull request tidymodels#687 from jmarshallnz/set_engine_docs

refine documentation of set_engine to make passing arguments to the engine fit function clearer
AlexisBocuze · Mar 22, 2022 · 6928a6d · 6928a6d
2 parents e666d82 + 9f4ff0e
commit 6928a6d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/R/engines.R b/R/engines.R
@@ -78,7 +78,8 @@ load_libs <- function(x, quiet, attach = FALSE) {
 #' these in your model type function, like `rand_forest(trees = 2000)`.
 #' - _Engine arguments_ are either specific to a particular engine or used
 #' more rarely; there is no change for these argument names from the underlying
-#' engine. Set these in `set_engine()`, like
+#' engine. The `...` argument of `set_engine()` allows any engine-specific
+#' argument to be passed directly to the engine fitting function, like
 #' `set_engine("ranger", importance = "permutation")`.
 #'
 #'

diff --git a/man/set_engine.Rd b/man/set_engine.Rd