Skip to content

Commit

Permalink
fix again
Browse files Browse the repository at this point in the history
  • Loading branch information
RossanaTat committed Jun 11, 2024
1 parent 28d17f6 commit 5f1ed7e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 16 deletions.
15 changes: 7 additions & 8 deletions R/info_display.R
Original file line number Diff line number Diff line change
Expand Up @@ -127,32 +127,31 @@ store_msg <- function(type, ...) {
#' @param info A character string representing an info message to be stored. Default value is NULL
#'
#' @section Hot to pass the message string:
#' The function allows for the customization of the message string using \{cli\} classes to emphasize specific components of the message
#' The function allows for the customization of the message string using cli classes to emphasize specific components of the message
#' Here's how to format the message string:
#' *For variables: .strongVar
#' *For function arguments: .strongArg
#' *For dt/df: .strongTable
#' *For text/anything else: .strong
#' *NOTE: By default, the number of seconds specified in timing messages is
#' automatically emphasized using a custom formatting approach.
#' You do not need to apply {cli} classes nor to specify that the number is in seconds.
#' You do not need to apply cli classes nor to specify that the number is in seconds.
#'
#'
#'
#' @return invisible TRUE
#'
#' @examples
#' \donotrun{
#' # Timing msg
#' store_joyn_msg(timing = paste(" The entire joyn function, including checks,
#' is executed in ", round(time_taken_joyn, 6)))
#' joyn:::store_joyn_msg(timing = paste(" The entire joyn function, including checks,
#' is executed in ", round(1.8423467, 6)))
#'
#' # Error msg
#' store_joyn_msg(err = " Input table {.strongTable x} has no columns.")
#' joyn:::store_joyn_msg(err = " Input table {.strongTable x} has no columns.")
#'
#' # Info msg
#' store_joyn_msg(info = "Joyn's report available in variable {.strongVar {reportvar}}")
#' }
#' joyn:::store_joyn_msg(info = "Joyn's report available in variable {.strongVar .joyn}")
#'
#'
#' @keywords internal
store_joyn_msg <- function(err = NULL,
Expand Down
15 changes: 7 additions & 8 deletions man/store_joyn_msg.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5f1ed7e

Please sign in to comment.