From 11f8babb0fc5d5657b3388b3194b15566edb4563 Mon Sep 17 00:00:00 2001 From: Lionel Henry Date: Fri, 17 Feb 2023 09:07:49 +0100 Subject: [PATCH] Apply suggestions from doc review Co-authored-by: Davis Vaughan --- R/nse-inject.R | 6 +++++- man/englue.Rd | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/R/nse-inject.R b/R/nse-inject.R index 467292010..24e287890 100644 --- a/R/nse-inject.R +++ b/R/nse-inject.R @@ -390,7 +390,7 @@ NULL #' #' @section Wrapping `englue()`: #' -#' You can provide englue semantics to a string by supplying `env`. +#' You can provide englue semantics to a user provided string by supplying `env`. #' In this example we create a variant of `englue()` that supports a #' special `.qux` pronoun by: #' @@ -425,6 +425,10 @@ NULL #' fn(bar) #' ``` #' +#' If you are creating a low level package on top of englue(), you +#' should also consider exposing `env`, `error_arg` and `error_call` +#' in your `englue()` wrapper so users can wrap your wrapper. +#' #' @seealso #' - `r link("topic_inject")` #' diff --git a/man/englue.Rd b/man/englue.Rd index 88130dd7a..8b7f683ec 100644 --- a/man/englue.Rd +++ b/man/englue.Rd @@ -48,7 +48,7 @@ installed by adding it to your \verb{Imports:} section. \section{Wrapping \code{englue()}}{ -You can provide englue semantics to a string by supplying \code{env}. +You can provide englue semantics to a user provided string by supplying \code{env}. In this example we create a variant of \code{englue()} that supports a special \code{.qux} pronoun by: \itemize{ @@ -82,6 +82,10 @@ fn <- function(x) \{ fn(bar) #> [1] "bar_QUX_FOO" }\if{html}{\out{}} + +If you are creating a low level package on top of englue(), you +should also consider exposing \code{env}, \code{error_arg} and \code{error_call} +in your \code{englue()} wrapper so users can wrap your wrapper. } \examples{