Skip to content

Commit

Permalink
Fix README to reflect devtools v2.0.1
Browse files Browse the repository at this point in the history
- "devtools" v2.0.1 mixed up the logic for "dontrun" examples (see https://github.com/r-lib/devtools/issues/2003); until this is fixed, use `devtools::run_examples(run = FALSE)`

- Note: revert this commit once devtools issue 2003 is fixed
  • Loading branch information
dschlaep committed Mar 11, 2019
1 parent d56849a commit 05f7798
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,10 @@ You can contribute to this project in different ways:
note: you may need to compile dynamic libraries first with
`pkgbuild::compile_dll()`.
* Ideally, add examples to function documentation and check these examples
with the command `devtools::run_examples()`
with the command `devtools::run_examples()`.
Note: "devtools" v2.0.1 mixed up the logic for "dontrun" examples (see
https://github.com/r-lib/devtools/issues/2003); until this is fixed,
use `devtools::run_examples(run = FALSE)`.
* Ideally, expand and/or add vignettes.
Expand Down Expand Up @@ -278,6 +281,9 @@ You can contribute to this project in different ways:
```{r}
devtools::run_examples()
```
Note: "devtools" v2.0.1 mixed up the logic for "dontrun" examples (see
https://github.com/r-lib/devtools/issues/2003); until this is fixed,
use `devtools::run_examples(run = FALSE)`.
1. Run tests as if not on CRAN, in an interactive R session,
and with a sequential schedule.
Expand Down

0 comments on commit 05f7798

Please sign in to comment.