From b1b52d18853c46b58c209cb57a4edb538f05cd07 Mon Sep 17 00:00:00 2001 From: Sam El-Kamand Date: Wed, 13 Nov 2024 14:05:57 +1100 Subject: [PATCH] fix: escaped curl braces so docs render correctly --- R/assert.R | 3 ++- man/assert.Rd | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/R/assert.R b/R/assert.R index 511b391..dbe0b55 100644 --- a/R/assert.R +++ b/R/assert.R @@ -1,7 +1,8 @@ #' Assert that conditions are met #' #' @param ... a list of conditions to check -#' @param msg A character string containing the error message to display if any of the conditions are not met. The string can include the placeholder {failed_expressions} to insert a list of the failed expressions. The string can also include {?s} and {?is/are} to insert the correct pluralization for the list of failed expressions. +#' @param msg A character string containing the error message to display if any of the conditions are not met. +#' The string can include the placeholder \{failed_expressions\} to insert a list of the failed expressions. The string can also include \{?s\} and \{?is/are\} to insert the correct pluralization for the list of failed expressions. #' @inheritParams common_roxygen_params #' #' @return invisible(TRUE) if all conditions are met, otherwise aborts with the error message specified by msg diff --git a/man/assert.Rd b/man/assert.Rd index 337e2b5..22e8870 100644 --- a/man/assert.Rd +++ b/man/assert.Rd @@ -9,7 +9,8 @@ assert(..., msg = NULL, call = rlang::caller_env()) \arguments{ \item{...}{a list of conditions to check} -\item{msg}{A character string containing the error message to display if any of the conditions are not met. The string can include the placeholder {failed_expressions} to insert a list of the failed expressions. The string can also include {?s} and {?is/are} to insert the correct pluralization for the list of failed expressions.} +\item{msg}{A character string containing the error message to display if any of the conditions are not met. +The string can include the placeholder \{failed_expressions\} to insert a list of the failed expressions. The string can also include \{?s\} and \{?is/are\} to insert the correct pluralization for the list of failed expressions.} \item{call}{Only relevant when pooling assertions into multi-assertion helper functions. See \link[cli]{cli_abort} for details.} }