Tie up loose ends around making check(cleanup =) defunct (#2455)

* Tie up loose ends around making check(cleanup =) defunct

Closes #2448

* More work on docs

Closes #2454

* Update R/check.R

Co-authored-by: Hadley Wickham <h.wickham@gmail.com>

* Re-document()

Co-authored-by: Hadley Wickham <h.wickham@gmail.com>

Author: jennybc

NEWS.md

@@ -1,5 +1,9 @@
 # devtools (development version)
 
+* `check(cleanup =)` was deprecated in devtools v1.11.0 (2016-04-12) and was
+  made defunct in v2.4.4 (2022-07-20). The documentation is more clear now about
+  recommended alternatives.
+
 # devtools 2.4.4
 
 * `install(reload = TRUE)` now calls `pkgload::unregister()` instead

R/check.R

@@ -1,18 +1,19 @@
-#' Build and check a package, cleaning up automatically on success.
+#' Build and check a package
 #'
-#' `check` automatically builds and checks a source package, using all
-#' known best practices. `check_built` checks an already built package.
+#' @description
+#' `check()` automatically builds and checks a source package, using all known
+#' best practices. `check_built()` checks an already-built package.
 #'
-#' Passing `R CMD check` is essential if you want to submit your package
-#' to CRAN: you must not have any ERRORs or WARNINGs, and you want to ensure
-#' that there are as few NOTEs as possible.  If you are not submitting to CRAN,
-#' at least ensure that there are no ERRORs or WARNINGs: these typically
-#' represent serious problems.
+#' Passing `R CMD check` is essential if you want to submit your package to
+#' CRAN: you must not have any ERRORs or WARNINGs, and you want to ensure that
+#' there are as few NOTEs as possible.  If you are not submitting to CRAN, at
+#' least ensure that there are no ERRORs or WARNINGs: these typically represent
+#' serious problems.
 #'
-#' `check` automatically builds a package before calling `check_built`
-#' as this is the recommended way to check packages.  Note that this process
-#' runs in an independent realisation of R, so nothing in your current
-#' workspace will affect the process.
+#' `check()` automatically builds a package before calling `check_built()`, as
+#' this is the recommended way to check packages.  Note that this process runs
+#' in an independent R session, so nothing in your current workspace will affect
+#' the process.
 #'
 #' @section Environment variables:
 #'
@@ -39,17 +40,15 @@
 #'
 #' @return An object containing errors, warnings, and notes.
 #' @template devtools
+#' @inheritParams rcmdcheck::rcmdcheck
 #' @param document By default (`NULL`) will document if your installed
 #'   roxygen2 version matches the version declared in the `DESCRIPTION`
 #'   file. Use `TRUE` or `FALSE` to override the default.
 #' @param build_args Additional arguments passed to `R CMD build`
-#' @param check_dir the directory in which the package is checked
-#'   compatibility. `args = "--output=/foo/bar"` can be used to change the
-#'   check directory.
 #' @param ... Additional arguments passed on to [pkgbuild::build()].
 #' @param vignettes If `FALSE`, do not build or check vignettes, equivalent to
 #'   using `args = '--ignore-vignettes' and `build_args = '--no-build-vignettes'.
-#' @param cleanup Deprecated.
+#' @param cleanup `r lifecycle::badge("deprecated")` See `check_dir` for details.
 #' @seealso [release()] if you want to send the checked package to
 #'   CRAN.
 #' @export
@@ -67,16 +66,16 @@ check <- function(pkg = ".",
                   env_vars = c(NOT_CRAN = "true"),
                   quiet = FALSE,
                   check_dir = tempdir(),
-                  cleanup = TRUE,
+                  cleanup = deprecated(),
                   vignettes = TRUE,
                   error_on = c("never", "error", "warning", "note")) {
   pkg <- as.package(pkg)
   withr::local_options(list(warn = 1))
 
   save_all()
 
-  if (!missing(cleanup)) {
-    lifecycle::deprecate_stop("1.11.0", "lifecycle::check(cleanup = )")
+  if (lifecycle::is_present(cleanup)) {
+    lifecycle::deprecate_stop("1.11.0", "check(cleanup = )")
   }
 
   if (missing(error_on) && !interactive()) {
@@ -158,22 +157,19 @@ can_document <- function(pkg) {
 #' @export
 #' @rdname check
 #' @param path Path to built package.
-#' @param cran if `TRUE` (the default), check using the same settings as
-#'   CRAN uses.
-#' @param remote Sets `_R_CHECK_CRAN_INCOMING_REMOTE_` env var.
-#'   If `TRUE`, performs a number of CRAN incoming checks that require
-#'   remote access.
-#' @param incoming Sets `_R_CHECK_CRAN_INCOMING_` env var.
-#'   If `TRUE`, performs a number of CRAN incoming checks.
-#' @param force_suggests Sets `_R_CHECK_FORCE_SUGGESTS_`. If
-#'   `FALSE` (the default), check will proceed even if all suggested
-#'   packages aren't found.
-#' @param run_dont_test Sets `--run-donttest` so that tests surrounded in
-#'   `\donttest{}` are also tested. When `cran = TRUE`, this only affects
-#'   R 3.6 and earlier; in R 4.0.0 code in `\donttest{}` is always run as
-#'   part of CRAN submission.
-#' @param manual If `FALSE`, don't build and check manual
-#'   (`--no-manual`).
+#' @param cran if `TRUE` (the default), check using the same settings as CRAN
+#'   uses.
+#' @param remote Sets `_R_CHECK_CRAN_INCOMING_REMOTE_` env var. If `TRUE`,
+#'   performs a number of CRAN incoming checks that require remote access.
+#' @param incoming Sets `_R_CHECK_CRAN_INCOMING_` env var. If `TRUE`, performs a
+#'   number of CRAN incoming checks.
+#' @param force_suggests Sets `_R_CHECK_FORCE_SUGGESTS_`. If `FALSE` (the
+#'   default), check will proceed even if all suggested packages aren't found.
+#' @param run_dont_test Sets `--run-donttest` so that examples surrounded in
+#'   `\donttest{}` are also run. When `cran = TRUE`, this only affects R 3.6 and
+#'   earlier; in R 4.0, code in `\donttest{}` is always run as part of CRAN
+#'   submission.
+#' @param manual If `FALSE`, don't build and check manual (`--no-manual`).
 #' @param env_vars Environment variables set during `R CMD check`
 #' @param quiet if `TRUE` suppresses output from this function.
 #' @inheritParams rcmdcheck::rcmdcheck