Show how to use call = base::call() in abort() (#1704)

* Show how to use call = `base::call()` * Tweak wording and fix missing `message` argument --------- Co-authored-by: Lionel Henry <[email protected]>
r-lib · May 31, 2024 · d7be54d · d7be54d
1 parent 5338bff
commit d7be54d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/R/cnd-abort.R b/R/cnd-abort.R
@@ -246,6 +246,17 @@
 #'   })
 #' )
 #'
+#' # You can also hard-code the call when it's not easy to
+#' # forward it from the caller
+#'  f <- function() {
+#'   abort("my message", call = call("my_function"))
+#' }
+#' g <- function() {
+#'   f()
+#' }
+#' # Shows that the error occured in `my_function()`
+#' try(g())
+#'
 #' }
 #' @export
 abort <- function(message = NULL,

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