Merge pull request #9 from rossellhayes/fix/check_always-fake-example

Hardcode output in examples section for `check_always()`
Paulj1989 · Feb 20, 2024 · ac8e6fc · ac8e6fc
2 parents 8380795 + 8aab3b5
commit ac8e6fc
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/R/check_always.R b/R/check_always.R
@@ -21,12 +21,19 @@ nice_callback <- function(expr, value, ok, visible) {
 #'
 #' @export
 #'
-#' @examples
+#' @section Examples:
+#' ```r
 #' check_always()
+#' #> Now checking whether all output is nice
 #' 23 * 3
+#' #> [1] 69
+#' #> Nice!
 #'
 #' uncheck_always()
+#' #> No longer checking whether all output is nice
 #' 23 * 3
+#' #> [1] 69
+#' ```
 check_always <- function(verbose = TRUE) {
   if ("nice_callback" %in% getTaskCallbackNames()) {
     if (isTRUE(verbose)) message("Already checking whether all output is nice")

diff --git a/man/check_always.Rd b/man/check_always.Rd