From 7298f2f0ddab2d34f0ef1b7ba95463634b48f5ec Mon Sep 17 00:00:00 2001 From: olivroy <52606734+olivroy@users.noreply.github.com> Date: Fri, 31 May 2024 06:59:37 -0400 Subject: [PATCH] Add cross-ref between the ellipsis checking functions (#1709) --- R/dots-ellipsis.R | 3 +++ man/check_dots_empty.Rd | 6 ++++++ man/check_dots_unnamed.Rd | 6 ++++++ man/check_dots_used.Rd | 6 ++++++ 4 files changed, 21 insertions(+) diff --git a/R/dots-ellipsis.R b/R/dots-ellipsis.R index ecc6dae598..0e7635a2fe 100644 --- a/R/dots-ellipsis.R +++ b/R/dots-ellipsis.R @@ -11,6 +11,7 @@ #' @param env Environment in which to look for `...` and to set up handler. #' @inheritParams args_error_context #' +#' @family dots checking functions #' @details #' In packages, document `...` with this standard tag: #' @@ -91,6 +92,7 @@ check_dots <- function(env = caller_env(), error, action, call) { #' fail with an error when named arguments are detected. #' #' @inheritParams check_dots_used +#' @family dots checking functions #' @param env Environment in which to look for `...`. #' @export #' @examples @@ -139,6 +141,7 @@ check_dots_unnamed <- function(env = caller_env(), #' @inheritParams check_dots_used #' @param env Environment in which to look for `...`. #' +#' @family dots checking functions #' @details #' In packages, document `...` with this standard tag: #' diff --git a/man/check_dots_empty.Rd b/man/check_dots_empty.Rd index 7ec44d9904..e2b7b760cd 100644 --- a/man/check_dots_empty.Rd +++ b/man/check_dots_empty.Rd @@ -52,3 +52,9 @@ try(f(1, foof = 4)) f(1, foofy = 4) } +\seealso{ +Other dots checking functions: +\code{\link{check_dots_unnamed}()}, +\code{\link{check_dots_used}()} +} +\concept{dots checking functions} diff --git a/man/check_dots_unnamed.Rd b/man/check_dots_unnamed.Rd index aa3dde8df2..abb3117326 100644 --- a/man/check_dots_unnamed.Rd +++ b/man/check_dots_unnamed.Rd @@ -39,3 +39,9 @@ f(1, 2, 3, foofy = 4) try(f(1, 2, 3, foof = 4)) } +\seealso{ +Other dots checking functions: +\code{\link{check_dots_empty}()}, +\code{\link{check_dots_used}()} +} +\concept{dots checking functions} diff --git a/man/check_dots_used.Rd b/man/check_dots_used.Rd index 64f6aa5e81..e62dfb5dd7 100644 --- a/man/check_dots_used.Rd +++ b/man/check_dots_used.Rd @@ -69,3 +69,9 @@ fn <- function(...) { fn() } +\seealso{ +Other dots checking functions: +\code{\link{check_dots_empty}()}, +\code{\link{check_dots_unnamed}()} +} +\concept{dots checking functions}