diff --git a/R/todo.R b/R/todo.R index 3061808..8f582b9 100644 --- a/R/todo.R +++ b/R/todo.R @@ -1,13 +1,13 @@ - #' Manage the package checking to-do list. #' -#' `revdep_todo()` tells you which packages still need to be checked. -#' `revdep_add()` adds a single package to the to-do list. -#' `revdep_rm()` removes packages from the todo list. - -#' `revdep_add_broken()` re-adds all broken packages from the last check -#' (this is useful if you think you've fixed the underlying problem in -#' your package). +#' @description +#' * `revdep_add()` adds a single package to the to-do list. +#' * `revdep_add_broken()` re-adds all broken packages from the last check +#' (this is useful if you think you've fixed the underlying problem in +#' your package). +#' * `revdep_add_new()` adds any new dependencies since the last run. +#' * `revdep_rm()` removes packages from the todo list. +#' * `revdep_todo()` tells you which packages still need to be checked. #' #' @inheritParams revdep_check #' @param packages Character vector of package names to add @@ -16,7 +16,6 @@ #' @param timeout_failures Whether to re-add packages that timed out. #' #' @export - revdep_add <- function(pkg = ".", packages) { pkg <- pkg_check(pkg) @@ -31,8 +30,8 @@ revdep_add <- function(pkg = ".", packages) { #' @export #' @rdname revdep_add - -revdep_add_broken <- function(pkg = ".", install_failures = FALSE, +revdep_add_broken <- function(pkg = ".", + install_failures = FALSE, timeout_failures = FALSE) { pkg <- pkg_check(pkg) @@ -51,7 +50,6 @@ revdep_add_broken <- function(pkg = ".", install_failures = FALSE, #' @export #' @rdname revdep_add - revdep_add_new <- function(pkg = ".") { pkg <- pkg_check(pkg) @@ -72,17 +70,16 @@ revdep_add_new <- function(pkg = ".") { #' @export #' @rdname revdep_add +revdep_rm <- function(pkg = ".", packages) { + pkg <- pkg_check(pkg) + db_todo_rm(pkg, packages) -revdep_todo <- function(pkg = ".") { - db_todo_status(pkg) + invisible(revdep_todo(pkg)) } #' @export #' @rdname revdep_add - -revdep_rm <- function(pkg = ".", packages) { +revdep_todo <- function(pkg = ".") { pkg <- pkg_check(pkg) - db_todo_rm(pkg, packages) - - invisible(revdep_todo(pkg)) + db_todo_status(pkg) } diff --git a/man/revdep_add.Rd b/man/revdep_add.Rd index 8fdac08..d5c2d84 100644 --- a/man/revdep_add.Rd +++ b/man/revdep_add.Rd @@ -4,8 +4,8 @@ \alias{revdep_add} \alias{revdep_add_broken} \alias{revdep_add_new} -\alias{revdep_todo} \alias{revdep_rm} +\alias{revdep_todo} \title{Manage the package checking to-do list.} \usage{ revdep_add(pkg = ".", packages) @@ -18,9 +18,9 @@ revdep_add_broken( revdep_add_new(pkg = ".") -revdep_todo(pkg = ".") - revdep_rm(pkg = ".", packages) + +revdep_todo(pkg = ".") } \arguments{ \item{pkg}{Path to package.} @@ -33,10 +33,13 @@ install.} \item{timeout_failures}{Whether to re-add packages that timed out.} } \description{ -\code{revdep_todo()} tells you which packages still need to be checked. -\code{revdep_add()} adds a single package to the to-do list. -\code{revdep_rm()} removes packages from the todo list. -\code{revdep_add_broken()} re-adds all broken packages from the last check +\itemize{ +\item \code{revdep_add()} adds a single package to the to-do list. +\item \code{revdep_add_broken()} re-adds all broken packages from the last check (this is useful if you think you've fixed the underlying problem in your package). +\item \code{revdep_add_new()} adds any new dependencies since the last run. +\item \code{revdep_rm()} removes packages from the todo list. +\item \code{revdep_todo()} tells you which packages still need to be checked. +} }