Skip to content

Commit 5097d4a

Browse files
committed
more informative text for show_engines()
1 parent b6c99d0 commit 5097d4a

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

R/engines.R

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,12 +107,15 @@ set_engine <- function(object, engine, ...) {
107107
)
108108
}
109109

110-
#' Display available engines for a model
110+
#' Display currently available engines for a model
111111
#'
112-
#' The possible engines for a model may depend on what packages are loaded. There
113-
#' are some `parsnip`-adjacent packages that only add engines to existing models.
112+
#' The possible engines for a model can depend on what packages are loaded.
113+
#' Some `parsnip`-adjacent packages add engines to existing models. For example,
114+
#' the `multilevelmod` package adds additional engines for the [linear_reg()]
115+
#' model and these are not available unless `multilevelmod` is loaded.
114116
#' @param x The name of a `parsnip` model (e.g., "linear_reg", "mars", etc.)
115117
#' @return A tibble.
118+
#' @examples
116119
#' show_engines("linear_reg")
117120
#' @export
118121
show_engines <- function(x) {

man/show_engines.Rd

Lines changed: 8 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)