Documentation of `run_dont_test`

r-lib / devtools

Tools to make an R developer's life easier

https://devtools.r-lib.org

Other

2.37k stars 753 forks source link

Documentation of `run_dont_test` #2454

Closed fweber144 closed 1 year ago

fweber144 commented 1 year ago

It seems like the documentation of devtools::check()'s argument run_dont_test has some typos/mistakes. It says:

Sets --run-donttest so that tests surrounded in ⁠\dontest{}⁠ are also tested. When cran = TRUE, this only affects R 3.6 and earlier; in R 4.0.0 code in ⁠\dontest{}⁠ is always run as part of CRAN submission.

Firstly, I think the two occurrences of \dontest{} need to read⁠ \donttest{}⁠. And secondly, \donttest{}⁠ is for examples, not tests.

fweber144 commented 1 year ago

Sorry, the replacement of \dontest{} by⁠ \donttest{}⁠ seems to have taken place in devtools v2.4.4. I'm currently using v2.4.3 because of #2448. However, the documentation in v2.4.4 still says "tests" instead of "examples".