Tweak reference index

Author: hadley

R/expect-comparison.R

@@ -1,4 +1,4 @@
-#' Expectation: is returned value less or greater than specified value?
+#' Is a number greater than or less than the expected value?
 #'
 #' @inheritParams expect_equal
 #' @param expected Single numeric value to compare.

R/expect-condition.R

@@ -1,4 +1,4 @@
-#' Expectation: does code throw an error, warning, message, or other condition?
+#' Does code throw an error, warning, message, or other condition?
 #'
 #' @description
 #' `expect_error()`, `expect_warning()`, `expect_message()`, and

R/expect-constant.R

@@ -1,4 +1,4 @@
-#' Expectation: is the object true/false?
+#' Is an object true/false?
 #'
 #' These are fall-back expectations that you can use when none of the other
 #' more specific expectations apply. The disadvantage is that you may get
@@ -44,7 +44,7 @@ expect_false <- function(object, info = NULL, label = NULL) {
   expect_waldo_constant(act, FALSE, info = info)
 }
 
-#' Expectation: is an object `NULL`?
+#' Is an object `NULL`?
 #'
 #' This is a special case because `NULL` is a singleton so it's possible
 #' check for it either with `expect_equal(x, NULL)` or `expect_type(x, "NULL")`.

R/expect-equality.R

@@ -1,4 +1,4 @@
-#' Expectation: is an object equal to a reference value?
+#' Is an object equal to the expected value?
 #'
 #' @description
 #' These functions provide two levels of strictness when comparing a
@@ -128,7 +128,7 @@ expect_waldo_equal <- function(type, act, exp, info, ...) {
   invisible(act$val)
 }
 
-#' Expectation: is an object equal to a reference value, ignoring attributes?
+#' Is an object equal to the expected value, ignoring attributes?
 #'
 #' Compares `object` and `expected` using [all.equal()] and
 #' `check.attributes = FALSE`.
@@ -170,7 +170,7 @@ expect_equivalent <- function(object, expected, ..., info = NULL, label = NULL,
 }
 
 
-#' Do two names point to the same underlying object?
+#' Does code yield a reference to the expected object?
 #'
 #' `expect_reference()` compares the underlying memory addresses of
 #' two symbols. It is for expert use only.

R/expect-inheritance.R

@@ -1,4 +1,4 @@
-#' Expectation: does the object inherit from a S3 or S4 class, or is it a base type?
+#' Does an object inherit from a S3 or S4 class, or is it a base type?
 #'
 #' @description
 #' See <https://adv-r.hadley.nz/oo.html> for an overview of R's OO systems, and
@@ -103,7 +103,7 @@ expect_s4_class <- function(object, class) {
 
 isS3 <- function(x) is.object(x) && !isS4(x)
 
-#' Expectation: does the object inherit from a given class?
+#' Does an object inherit from a given class?
 #'
 #' @description
 #' `r lifecycle::badge("superseded")`

R/expect-invisible.R

@@ -1,4 +1,4 @@
-#' Expectation: does expression return visibly or invisibly?
+#' Does code return visibly or invisibly?
 #'
 #' Use this to test whether a function returns a visible or invisible
 #' output. Typically you'll use this to check that functions called primarily

R/expect-length.R

@@ -1,4 +1,4 @@
-#' Expectation: does a vector have the specified length?
+#' Does a vector have the specified length?
 #'
 #' @seealso [expect_vector()] to make assertions about the "size" of a vector
 #' @inheritParams expect_that

R/expect-named.R

@@ -1,4 +1,4 @@
-#' Expectation: does object have names?
+#' Does a vector have names?
 #'
 #' You can either check for the presence of names (leaving `expected`
 #' blank), specific names (by supplying a vector of names), or absence of

R/expect-output.R

@@ -1,4 +1,4 @@
-#' Expectation: does code print output to the console?
+#' Does code print output to the console?
 #'
 #' Test for output produced by `print()` or `cat()`. This is best used for
 #' very simple output; for more complex cases use [verify_output()].

R/expect-setequal.R

@@ -1,4 +1,4 @@
-#' Expectation: do two vectors contain the same values?
+#' Does a vector contain the same values as the expected vector?
 #'
 #' * `expect_setequal(x, y)` tests that every element of `x` occurs in `y`,
 #'    and that every element of `y` occurs in `x`.

R/expect-silent.R

@@ -1,4 +1,4 @@
-#' Expectation: is the code silent?
+#' Does code execute silently?
 #'
 #' Checks that the code produces no output, messages, or warnings.
 #'

R/expect-vector.R

@@ -1,4 +1,4 @@
-#' Expectation: does the object have vctr properties?
+#' Does a vector have the specified size and/or prototype?
 #'
 #' `expect_vector()` is a thin wrapper around [vctrs::vec_assert()], converting
 #' the results of that function in to the expectations used by testthat. This

R/expectations-matches.R

@@ -1,4 +1,4 @@
-#' Expectation: does string match a regular expression?
+#' Does a string match a regular expression?
 #'
 #' @details
 #' `expect_match()` is a wrapper around [grepl()]. See its documentation for

R/old-school.R

@@ -133,7 +133,7 @@ matches <- function(regexp, all = TRUE, ...) {
 }
 
 
-#' Expectation: does expression take less than a fixed amount of time to run?
+#' Does code take less than the expected amount of time to run?
 #'
 #' This is useful for performance regression testing.
 #'

R/test-compiled-code.R

@@ -20,7 +20,7 @@ expect_cpp_tests_pass <- function(package) {
   expect(tests_passed, paste("C++ unit tests:", info, sep = "\n"))
 }
 
-#' Expectation: do C++ tests past?
+#' Do C++ tests past?
 #'
 #' Test compiled code in the package `package`. A call to this function will
 #' automatically be generated for you in `tests/testthat/test-cpp.R` after

R/verify-output.R

@@ -43,6 +43,7 @@
 #'   test on your CI platforms that don't support UTF-8 (e.g. Windows).
 #' @param env The environment to evaluate `code` in.
 #' @export
+#' @keywords internal
 #' @examples
 #' # The first argument would usually be `test_path("informative-name.txt"`)
 #' # but that is not permitted in examples

_pkgdown.yml

@@ -14,14 +14,24 @@ reference:
 - title: Expectations
   contents:
   - starts_with("expect_")
+  - -starts_with("expect_snapshot_")
+
+- title: Snapshot testing
+  contents:
+  - starts_with("expect_snapshot_")
+  - starts_with("snapshot_")
+
+- test: Test helpers
+  contents:
+  - is_testing
   - skip
-  - verify_output
+  - teardown_env
 
 - title: Run tests
   contents:
-  - starts_with("test_")
   - starts_with("auto_test")
   - describe
+  - starts_with("test_")
   - use_catch
 
 - title: Reporters