From 0c43d6748cc1d20abfce11d6c5453e3e9c56d596 Mon Sep 17 00:00:00 2001 From: topepo Date: Mon, 7 Aug 2023 17:45:47 -0400 Subject: [PATCH] Documented arguments not in \usage --- DESCRIPTION | 2 +- R/aaa_models.R | 5 ----- R/engine_docs.R | 1 - R/misc.R | 2 +- man/knit_engine_docs.Rd | 2 -- man/set_new_model.Rd | 8 -------- man/show_call.Rd | 2 +- 7 files changed, 3 insertions(+), 19 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a281911d4..45d8f6690 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -76,4 +76,4 @@ Config/testthat/edition: 3 Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.2.3.9000 diff --git a/R/aaa_models.R b/R/aaa_models.R index 81f28ba6d..c27d21379 100644 --- a/R/aaa_models.R +++ b/R/aaa_models.R @@ -473,7 +473,6 @@ check_interface_val <- function(x) { #' `"rand_forest"`, etc). #' @param mode A single character string for the model mode (e.g. "regression"). #' @param eng A single character string for the model engine. -#' @param arg A single character string for the model argument name. #' @param has_submodel A single logical for whether the argument #' can make predictions on multiple submodels at once. #' @param func A named character vector that describes how to call @@ -483,10 +482,6 @@ check_interface_val <- function(x) { #' used to invoke the usual linear regression function. In some #' cases, it is helpful to use `c(fun = "predict")` when using a #' package's `predict` method. -#' @param fit_obj A list with elements `interface`, `protect`, -#' `func` and `defaults`. See the package vignette "Making a -#' `parsnip` model from scratch". -#' @param pred_obj A list with elements `pre`, `post`, `func`, and `args`. #' @param type A single character value for the type of prediction. Possible #' values are: `class`, `conf_int`, `numeric`, `pred_int`, `prob`, `quantile`, #' and `raw`. diff --git a/R/engine_docs.R b/R/engine_docs.R index 5274544a0..a87735eb4 100644 --- a/R/engine_docs.R +++ b/R/engine_docs.R @@ -1,7 +1,6 @@ #' Knit engine-specific documentation #' @param pattern A regular expression to specify which files to knit. The #' default knits all engine documentation files. -#' @param ... Options passed to [knitr::knit()]. #' @return A tibble with column `file` for the file name and `result` (a #' character vector that echos the output file name or, when there is #' a failure, the error message). diff --git a/R/misc.R b/R/misc.R index 0e5b3be88..7e6a7c469 100644 --- a/R/misc.R +++ b/R/misc.R @@ -234,7 +234,7 @@ prompt_missing_implementation <- function(spec, #' Print the model call #' -#' @param x A "model_spec" object. +#' @param object A "model_spec" object. #' @return A character string. #' @keywords internal #' @export diff --git a/man/knit_engine_docs.Rd b/man/knit_engine_docs.Rd index 9aea69827..3315d0eb2 100644 --- a/man/knit_engine_docs.Rd +++ b/man/knit_engine_docs.Rd @@ -9,8 +9,6 @@ knit_engine_docs(pattern = NULL) \arguments{ \item{pattern}{A regular expression to specify which files to knit. The default knits all engine documentation files.} - -\item{...}{Options passed to \code{\link[knitr:knit]{knitr::knit()}}.} } \value{ A tibble with column \code{file} for the file name and \code{result} (a diff --git a/man/set_new_model.Rd b/man/set_new_model.Rd index 1c6a809ec..f77ccd712 100644 --- a/man/set_new_model.Rd +++ b/man/set_new_model.Rd @@ -87,14 +87,6 @@ prediction objects.} \item{options}{A list of options for engine-specific preprocessing encodings. See Details below.} - -\item{arg}{A single character string for the model argument name.} - -\item{fit_obj}{A list with elements \code{interface}, \code{protect}, -\code{func} and \code{defaults}. See the package vignette "Making a -\code{parsnip} model from scratch".} - -\item{pred_obj}{A list with elements \code{pre}, \code{post}, \code{func}, and \code{args}.} } \description{ These functions are similar to constructors and can be used to validate diff --git a/man/show_call.Rd b/man/show_call.Rd index 36b4fe6f5..5ede688b7 100644 --- a/man/show_call.Rd +++ b/man/show_call.Rd @@ -7,7 +7,7 @@ show_call(object) } \arguments{ -\item{x}{A "model_spec" object.} +\item{object}{A "model_spec" object.} } \value{ A character string.