docs: add read_only docs

lorenzwalthert · Nov 10, 2023 · 9a99319 · 9a99319
1 parent 8962b20
commit 9a99319
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/R/testing.R b/R/testing.R
@@ -86,6 +86,8 @@ run_test <- function(hook_name,
 #' @param expect_success Whether or not an exit code 0 is expected. This can
 #'   be derived from `std_err`, but sometimes, non-empty stderr does not mean
 #'   error, but just a message.
+#' @param read_only If `TRUE` and `artifacts` are not `NULL`, then assert that hook
+#'   did not modify the artifacts.
 #' @keywords internal
 run_test_impl <- function(path_executable,
                           path_candidate,

diff --git a/man/run_test.Rd b/man/run_test.Rd
diff --git a/man/run_test_impl.Rd b/man/run_test_impl.Rd