Skip to content

Commit

Permalink
Documented arguments not in \usage
Browse files Browse the repository at this point in the history
  • Loading branch information
topepo committed Aug 7, 2023
1 parent b96ad02 commit 0c43d67
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 19 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 0 additions & 5 deletions R/aaa_models.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`.
Expand Down
1 change: 0 additions & 1 deletion R/engine_docs.R
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 1 addition & 1 deletion R/misc.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions man/knit_engine_docs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 0 additions & 8 deletions man/set_new_model.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/show_call.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0c43d67

Please sign in to comment.