Polish reference index (#2180)

Fixes #2178

Author: hadley

R/describe.R

@@ -26,6 +26,7 @@
 #'
 #' @param description description of the feature
 #' @param code test code containing the specs
+#' @keywords internal
 #' @export
 #' @examples
 #' describe("matrix()", {

R/expect-comparison.R

@@ -1,4 +1,4 @@
-#' Does code return a number greater/less than the expected value?
+#' Do you expect a number bigger or smaller than this?
 #'
 #' @inheritParams expect_equal
 #' @param object,expected A value to compare and its expected bound.

R/expect-condition.R

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

R/expect-constant.R

@@ -1,4 +1,4 @@
-#' Does code return `TRUE` or `FALSE`?
+#' Do you expect `TRUE` or `FALSE`?
 #'
 #' @description
 #' These are fall-back expectations that you can use when none of the other
@@ -42,7 +42,7 @@ expect_false <- function(object, info = NULL, label = NULL) {
   expect_waldo_equal_("equal", act, exp, info = info, ignore_attr = TRUE)
 }
 
-#' Does code return `NULL`?
+#' Do you expect `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 @@
-#' Does code return the expected value?
+#' Do you expect this value?
 #'
 #' @description
 #' These functions provide two levels of strictness when comparing a

R/expect-inheritance.R

@@ -1,5 +1,4 @@
-#' Does code return an object inheriting from the expected base type, S3 class,
-#' or S4 class?
+#' Do you expect an S3/S4/R6/S7 object that inherits from this class?
 #'
 #' @description
 #' See <https://adv-r.hadley.nz/oo.html> for an overview of R's OO systems, and
@@ -207,7 +206,7 @@ expect_s7_class <- function(object, class) {
   pass(act$val)
 }
 
-#' Does an object inherit from a given class?
+#' Do you expect to inherit from this class?
 #'
 #' @description
 #' `r lifecycle::badge("superseded")`

R/expect-invisible.R

@@ -1,4 +1,4 @@
-#' Does code return a visible or invisible object?
+#' Do you expect the result to be (in)visible?
 #'
 #' 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-known.R

@@ -1,4 +1,4 @@
-#' Expectations: is the output or the value equal to a known good value?
+#' Do you expect the results/output to equal a known value?
 #'
 #' For complex printed output and objects, it is often challenging to describe
 #' exactly what you expect to see. `expect_known_value()` and
@@ -113,7 +113,7 @@ compare_file <- function(path, lines, ..., update = TRUE, info = NULL) {
   pass(NULL)
 }
 
-#' Expectations: is the output or the value equal to a known good value?
+#' Do you expect the output/result to equal a known good value?
 #'
 #' `expect_output_file()` behaves identically to [expect_known_output()].
 #'

R/expect-length.R

@@ -1,4 +1,4 @@
-#' Does code return a vector with the specified length?
+#' Do you expect a vector with this length?
 #'
 #' @seealso [expect_vector()] to make assertions about the "size" of a vector,
 #'   [expect_shape()] for more general assertions about object "shape".

R/expect-match.R

@@ -1,4 +1,4 @@
-#' Does a string match a regular expression?
+#' Do you expect a string to match this pattern?
 #'
 #' @details
 #' `expect_match()` checks if a character vector matches a regular expression,