Skip to content

Commit cfed3fb

Browse files
committed
Document ggplot2's approach to skipping tests
Closes #141
1 parent dd4b19b commit cfed3fb

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ To help you understand the causes of a failure, vdiffr automatically logs the SV
5656
You can also set the `VDIFFR_LOG_PATH` environment variable with `Sys.setenv()` to unconditionally (also interactively) log failures in the file pointed by the variable.
5757

5858

59+
### Skipping all vdiffr checks on some platforms
60+
61+
See ggplot2's approach which wraps `expect_doppelganger()` with a version that that calls `testthat::skip()` on the relevant platforms (as determined by environment variables): https://github.com/tidyverse/ggplot2/blob/ddd207e926cc1c1847dc661d9a099b8ec19c4010/tests/testthat/helper-vdiffr.R#L1-L15.
62+
63+
5964
## Building vdiffr
6065

6166
_This section is only relevant for building vdiffr from scratch, as opposed to installing from a pre-built package on CRAN._

0 commit comments

Comments
 (0)