improve caller_arg() documentation

r-lib · Feb 21, 2024 · f53fa15 · f53fa15
1 parent 84deb87
commit f53fa15
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/R/cnd-abort.R b/R/cnd-abort.R
@@ -1089,6 +1089,11 @@ NULL
 #' - Use `@inheritParams rlang::args_error_context` to document an
 #'   `arg` or `error_arg` argument that takes `error_arg()` as default.
 #'
+#' @section Use in `print()`:
+#' Note that `caller_arg()` will not work properly when redefining the
+#' `print()` method, as the name of the object is not in the callstack.
+#'
+#'
 #' @param arg An argument name in the current function.
 #' @usage NULL
 #'

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