Minor fix to run_examples documentation. (#2146)

* Fix documentation for run_examples. * Update default of run argument to match pkgload. Co-authored-by: Jim Hester <[email protected]>
r-lib · Feb 17, 2020 · 50e4aae · 50e4aae
1 parent 17d6ecf
commit 50e4aae
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/R/run-examples.R b/R/run-examples.R
@@ -15,7 +15,7 @@
 #' @param show DEPRECATED.
 #' @param test if `TRUE`, code in \code{\\donttest{}} will be commented
 #'   out. If `FALSE`, code in \code{\\testonly{}} will be commented out.
-#' @param run if `TRUE`, code in \code{\\dontrun{}} will be commented
+#' @param run if `FALSE`, code in \code{\\dontrun{}} will be commented
 #'   out.
 #' @param fresh if `TRUE`, will be run in a fresh R session. This has
 #'   the advantage that there's no way the examples can depend on anything in
@@ -26,7 +26,7 @@
 #' @keywords programming
 #' @export
 run_examples <- function(pkg = ".", start = NULL, show = TRUE, test = FALSE,
-                         run = TRUE, fresh = FALSE, document = TRUE) {
+                         run = FALSE, fresh = FALSE, document = TRUE) {
   pkg <- as.package(pkg)
 
   if (fresh) {

diff --git a/man/run_examples.Rd b/man/run_examples.Rd