Promote handlers() over option 'progressr.handlers'

Author: HenrikBengtsson

R/options.R

@@ -8,7 +8,7 @@
 #' @section Options for controlling progression reporting:
 #'
 #' \describe{
-#'  \item{\option{progressr.handlers}:}{(function or list of functions) Zero or more progression handlers that will report on any progression updates.  If NULL or an empty list, progress updates are ignored. (Default: `txtprogressbar_handler`)}
+#'  \item{\option{progressr.handlers}:}{(function or list of functions) Zero or more progression handlers that will report on any progression updates.  If empty list, progress updates are ignored.  If NULL, the default (`txtprogressbar_handler`) progression handlers is used.  The recommended way to set this option is via [progressr::handlers()]. (Default: NULL)}
 #' }
 #'
 #'

R/progression_handlers.R

@@ -625,7 +625,7 @@ newline_handler <- function(symbol = "\n", file = stderr(), intrusiveness = getO
 #'
 #' @examples
 #' \donttest{\dontrun{
-#' options(progressr.handlers = filesize_handler(file = "myscript.progress"))
+#' handlers(filesize_handler(file = "myscript.progress"))
 #' with_progress(y <- slow_sum(1:100))
 #' }}
 #'
@@ -692,7 +692,7 @@ filesize_handler <- function(file = "default.progress", intrusiveness = getOptio
 #'
 #' @examples
 #' \donttest{\dontrun{
-#' options(progressr.handlers = shiny_handler())
+#' handlers(shiny_handler())
 #' with_progress(y <- slow_sum(1:100))
 #' }}
 #'