don't document arguments that aren't used

tidymodels · Sep 25, 2023 · 8a2a5e0 · 8a2a5e0
1 parent 7e26290
commit 8a2a5e0
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 6 deletions.
diff --git a/R/engine_docs.R b/R/engine_docs.R
@@ -3,7 +3,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/hier_clust.R b/R/hier_clust.R
@@ -171,7 +171,7 @@ translate_tidyclust.hier_clust <- function(x, engine = x$engine, ...) {
 #'
 #' @param x matrix or data frame
 #' @param num_clusters the number of clusters
-#' @param h the height to cut the dendrogram
+#' @param cut_height the height to cut the dendrogram
 #' @param linkage_method the agglomeration method to be used. This should be (an
 #'   unambiguous abbreviation of) one of `"ward.D"`, `"ward.D2"`, `"single"`,
 #'   `"complete"`, `"average"` (= UPGMA), `"mcquitty"` (= WPGMA), `"median"` (=

diff --git a/man/dot-hier_clust_fit_stats.Rd b/man/dot-hier_clust_fit_stats.Rd
diff --git a/man/knit_engine_docs.Rd b/man/knit_engine_docs.Rd