Skip to content

Commit

Permalink
Mention R requirement in doc
Browse files Browse the repository at this point in the history
Closes #113
  • Loading branch information
lionel- committed Oct 22, 2024
1 parent 10534c3 commit 205cb46
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
6 changes: 6 additions & 0 deletions R/expect-doppelganger.R
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
#' Does a figure look like its expected output?
#'
#' @description
#'
#' `expect_doppelganger()` is a testthat expectation for graphical
#' plots. It generates SVG snapshots that you can review graphically
#' with [testthat::snapshot_review()]. You will find more information
#' about snapshotting in the [testthat snapshots
#' vignette](https://testthat.r-lib.org/articles/snapshotting.html).
#'
#' Note that `expect_doppelgagner()` requires R version 4.1.0. If run
#' on an earlier version of R, it emits a `testthat::skip()` so that you
#' can still run other checks on old versions of R.
#'
#' @param title A brief description of what is being tested in the
#' figure. For instance: "Points and lines overlap".
#'
Expand Down
4 changes: 4 additions & 0 deletions man/expect_doppelganger.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 205cb46

Please sign in to comment.