Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check that run_examples() documentation correct #2100

Closed
k-doering-NOAA opened this issue Sep 3, 2019 · 2 comments
Closed

Check that run_examples() documentation correct #2100

k-doering-NOAA opened this issue Sep 3, 2019 · 2 comments

Comments

@k-doering-NOAA
Copy link

https://github.com/r-lib/devtools/blob/master/R/run-examples.R#L19-L20 . From this documentation, I thought that running run_examples(run = TRUE) would mean that any examples enclosed with \dontrun{} would be ignored, but closed issue #1990 (and my own running of examples in an R package) suggests that I should use run_examples(run = FALSE) to not run examples enclosed with \dontrun{}.

I think the documentation needs to be updated to

#' @param run if `FALSE`, code in \code{\\dontrun{}} will be commented
#'   out.
@jimhester
Copy link
Member

I moved an issue to pkgload to track this r-lib/pkgload#107

@lock
Copy link

lock bot commented Mar 10, 2020

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/

@lock lock bot locked and limited conversation to collaborators Mar 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants