diff --git a/R/email.R b/R/email.R index f787c60c..7e738232 100644 --- a/R/email.R +++ b/R/email.R @@ -5,6 +5,7 @@ NULL #' @describeIn email Compose complete mail #' @inheritDotParams mc_render_email +#' @inheritParams biblids::doiEntryUI #' @export mc_compose_email <- function(dois, translator = mc_translator(), @@ -344,6 +345,7 @@ emailReportServer <- function(id, #' @describeIn emailReport Promise of a rendered and send email #' Emits notifications and progress bar updates. +#' @inheritParams mc_compose_email #' @inheritDotParams mc_compose_email #' @inheritParams smtp_send_mc #' @export diff --git a/R/report.R b/R/report.R index 377e24a9..b944c95f 100644 --- a/R/report.R +++ b/R/report.R @@ -40,6 +40,7 @@ draft_report <- function(lang = mc_langs, ...) { #' Render a parametrised metacheck report. #' @param dois #' Vector of DOIs, as created by, or coerceable to [biblids::doi()]. +#' @inheritParams biblids::doiEntryUI #' @inheritDotParams rmarkdown::render #' @inheritParams mcControlsServer #' @export diff --git a/man/email.Rd b/man/email.Rd index e2430eec..f172e418 100644 --- a/man/email.Rd +++ b/man/email.Rd @@ -30,6 +30,13 @@ smtp_send_mc( \arguments{ \item{dois}{Vector of DOIs, as created by, or coerceable to \code{\link[biblids:doi]{biblids::doi()}}.} +\item{translator}{A \link[shiny.i18n:Translator]{shiny.i18n::Translator} object or \code{NULL} for english-only defaults. +Strings inside the module UI are marked as translateable. +You can pass a translator object included in the package, +or can create your own \code{translator} using \link[shiny.i18n:Translator]{shiny.i18n::Translator}. +This must not be a reactive, it is only set at shiny startup. +To update the language reactively \emph{during} a shiny session, see \code{lang}.} + \item{...}{ Arguments passed on to \code{\link[=mc_render_email]{mc_render_email}}, \code{\link[blastula:render_email]{blastula::render_email}}, \code{\link[blastula:smtp_send]{blastula::smtp_send}} \describe{ diff --git a/man/report.Rd b/man/report.Rd index d6e291d1..ee04b238 100644 --- a/man/report.Rd +++ b/man/report.Rd @@ -99,6 +99,13 @@ pandoc command line and others. To only suppress printing of the last }} \item{dois}{Vector of DOIs, as created by, or coerceable to \code{\link[biblids:doi]{biblids::doi()}}.} + +\item{translator}{A \link[shiny.i18n:Translator]{shiny.i18n::Translator} object or \code{NULL} for english-only defaults. +Strings inside the module UI are marked as translateable. +You can pass a translator object included in the package, +or can create your own \code{translator} using \link[shiny.i18n:Translator]{shiny.i18n::Translator}. +This must not be a reactive, it is only set at shiny startup. +To update the language reactively \emph{during} a shiny session, see \code{lang}.} } \description{ Helper functions to generate a metacheck report.