From e93508308d13a3af4501cf08e71c5bc9eefc8f47 Mon Sep 17 00:00:00 2001 From: Garrick Aden-Buie Date: Wed, 6 Nov 2024 13:16:01 -0500 Subject: [PATCH] docs(runExample): `display.mode` follows DESCRIPTION Fixes #4077 The argument documentation wasn't updated to reflect that `runExample()` can run more than just Shiny's examples --- R/runapp.R | 4 +++- man/runExample.Rd | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/R/runapp.R b/R/runapp.R index c6af84a2a1..d302bc117d 100644 --- a/R/runapp.R +++ b/R/runapp.R @@ -445,7 +445,9 @@ stopApp <- function(returnValue = invisible()) { #' @param host The IPv4 address that the application should listen on. Defaults #' to the `shiny.host` option, if set, or `"127.0.0.1"` if not. #' @param display.mode The mode in which to display the example. Defaults to -#' `showcase`, but may be set to `normal` to see the example without +#' `"auto"`, which uses the value of `DisplayMode` in the example's +#' `DESCRIPTION` file. Set to `"showcase"` to show the app code and +#' description with the running app, or `"normal"` to see the example without #' code or commentary. #' @param package The package in which to find the example (defaults to #' `"shiny"`). diff --git a/man/runExample.Rd b/man/runExample.Rd index 56c3937459..aa20b3604a 100644 --- a/man/runExample.Rd +++ b/man/runExample.Rd @@ -33,7 +33,9 @@ interactive sessions only.} to the \code{shiny.host} option, if set, or \code{"127.0.0.1"} if not.} \item{display.mode}{The mode in which to display the example. Defaults to -\code{showcase}, but may be set to \code{normal} to see the example without +\code{"auto"}, which uses the value of \code{DisplayMode} in the example's +\code{DESCRIPTION} file. Set to \code{"showcase"} to show the app code and +description with the running app, or \code{"normal"} to see the example without code or commentary.} \item{package}{The package in which to find the example (defaults to