Bug in devtools::run_examples() devtools_2.0.1

[zellerivo]

run_examples(run= FALSE) does what run_examples(run=TRUE) is actually supposed to do, it comments out code in \dontrun{}.

[jimhester]

This is actually a bug in pkgload, these lines should not have ! before them

pkgload/R/dev-example.r

Lines 48 to 50 in 78e7e3a

	tools::Rd2ex(path, out = tmp, commentDontrun = !run)
	} else {
	tools::Rd2ex(path, out = tmp, commentDontrun = !run, commentDonttest = !test)

[salim-b]

run_examples(run= FALSE) does what run_examples(run=TRUE) is actually supposed to do, it comments out code in \dontrun{}.

Well, then I guess the same applies to run_examples(test= FALSE).

I.e. run_examples(test= FALSE) does what run_examples(test=TRUE) is actually supposed to do, it comments out code in \donttest{}.

IMHO: The param names run and test are not very well chosen. Actually, the current behaviour (which contradicts the documentation) seems intuitively correct to me.

[kwstat]

I'm confused by the wording of the documentation in regards to the run/test arguments. I would like to suggest that the wording be changed to be similar to what is shown by Rcmd check:

Rcmd check --help
      --run-dontrun     do run \dontrun sections in the Rd files
      --run-donttest    do run \donttest sections in the Rd files

Something like this makes more sense to me:

#' @param test if `TRUE`, do run code in \code{\\donttest{}} sections.
#' @param run if `TRUE`, do run code in \code{\\dontrun{}} sections.

[salim-b]

Something like this makes more sense to me:

#' @param test if `TRUE`, do run code in \code{\\donttest{}} sections.
#' @param run if `TRUE`, do run code in \code{\\dontrun{}} sections.

Why not:

#' @param run_donttest if `TRUE`, do run code in \code{\\donttest{}} sections.
#' @param run_dontrun if `TRUE`, do run code in \code{\\dontrun{}} sections.

IMHO, the clarity gained would by far outweigh the additional typing required.

[lionel-]

Fixed by r-lib/devtools#2146 and 3347012.