diff --git a/R/aaa-conditions.R b/R/aaa-conditions.R index 9422d22..77830e4 100644 --- a/R/aaa-conditions.R +++ b/R/aaa-conditions.R @@ -27,7 +27,7 @@ #' #' @inheritParams .shared-params #' @inheritParams stbl::pkg_warn -#' @returns Does not return. +#' @returns `NULL`, invisibly (called for warning side effect). #' @keywords internal .pkg_warn <- function( message, @@ -52,7 +52,7 @@ #' #' @inheritParams .shared-params #' @inheritParams stbl::pkg_inform -#' @returns Does not return. +#' @returns `NULL`, invisibly (called for message side effect). #' @keywords internal .pkg_inform <- function( message, diff --git a/inst/templates/aaa-conditions.R b/inst/templates/aaa-conditions.R index 1eaa043..4fccb78 100644 --- a/inst/templates/aaa-conditions.R +++ b/inst/templates/aaa-conditions.R @@ -27,7 +27,7 @@ #' #' @inheritParams .shared-params #' @inheritParams stbl::pkg_warn -#' @returns Does not return. +#' @returns `NULL`, invisibly (called for warning side effect). #' @keywords internal .pkg_warn <- function( message, @@ -52,7 +52,7 @@ #' #' @inheritParams .shared-params #' @inheritParams stbl::pkg_inform -#' @returns Does not return. +#' @returns `NULL`, invisibly (called for message side effect). #' @keywords internal .pkg_inform <- function( message, diff --git a/man/dot-pkg_inform.Rd b/man/dot-pkg_inform.Rd index ba6a0f1..bdaa0aa 100644 --- a/man/dot-pkg_inform.Rd +++ b/man/dot-pkg_inform.Rd @@ -32,7 +32,7 @@ evaluate variables in error messages.} \code{\link[rlang:abort]{rlang::inform()}}.} } \value{ -Does not return. +\code{NULL}, invisibly (called for message side effect). } \description{ Signal a package-scoped message diff --git a/man/dot-pkg_warn.Rd b/man/dot-pkg_warn.Rd index 8e62c3a..b20532f 100644 --- a/man/dot-pkg_warn.Rd +++ b/man/dot-pkg_warn.Rd @@ -32,7 +32,7 @@ evaluate variables in error messages.} \code{\link[rlang:abort]{rlang::warn()}}.} } \value{ -Does not return. +\code{NULL}, invisibly (called for warning side effect). } \description{ Signal a package-scoped warning