docs(bs_theme_preview): Missed in earlier pass

rstudio · Oct 19, 2023 · 2f534ab · 2f534ab
1 parent 9245693
commit 2f534ab
Show file tree

Hide file tree

Showing 15 changed files with 62 additions and 32 deletions.
diff --git a/R/bs-theme-preset-bootswatch.R b/R/bs-theme-preset-bootswatch.R
@@ -1,7 +1,7 @@
 #' Obtain a list of all available bootswatch themes.
 #'
-#' @param version the major version of Bootswatch.
-#' @param full_path whether to return a path to the installed theme.
+#' @param version The major version of Bootswatch.
+#' @param full_path Whether to return a path to the installed theme.
 #' @return Returns a character vector of Bootswatch themes.
 #' @family Bootstrap theme utility functions
 #' @export

diff --git a/R/bs-theme-preview.R b/R/bs-theme-preview.R
@@ -1,24 +1,32 @@
 #' @include utils.R
 NULL
 
-#' Preview the currently set theme
+#' Preview a Bootstrap theme
 #'
-#' Launches an example shiny app via `run_with_themer()` and
-#' `bs_theme_dependencies()`. Useful for getting a quick preview of the current
-#' theme setting as well as an interactive GUI for tweaking some of the main
-#' theme settings.
+#' Launches an example shiny app that can be used to get a quick preview of a
+#' [bs_theme()], as well as an interactive GUI for tweaking some of the
+#' main theme settings. Calling `bs_theme_preview()` with no arguments starts
+#' the theme preview app with the default theme, which is a great way to see
+#' the available theme presets or to start creating your own theme.
 #'
-#' The app that this launches is subject to change.
+#' The app that this launches is subject to change as new features are
+#' developed in \pkg{bslib} and \pkg{shiny}.
 #'
 #' @inheritParams bs_theme_update
 #' @param ... passed along to [shiny::runApp()].
 #' @param with_themer whether or not to run the app with [run_with_themer()].
+#'
 #' @return nothing, this function is called for its side-effects (launching an
 #'   application).
-#' @seealso [run_with_themer()]
-#' @examples
+#'
+#' @seealso Use [run_with_themer()] or [bs_themer()] to add the theming UI to
+#'   an existing shiny app.
+#'
+#' @examplesIf rlang::is_interactive()
 #' theme <- bs_theme(bg = "#6c757d", fg = "white", primary = "orange")
-#' if (interactive()) bs_theme_preview(theme)
+#' bs_theme_preview(theme)
+#'
+#' @family Bootstrap theme functions
 #' @export
 bs_theme_preview <- function(theme = bs_theme(), ..., with_themer = TRUE) {
   assert_bs_theme(theme)

diff --git a/man/bootswatch_themes.Rd b/man/bootswatch_themes.Rd
diff --git a/man/bs_bundle.Rd b/man/bs_bundle.Rd
diff --git a/man/bs_current_theme.Rd b/man/bs_current_theme.Rd
diff --git a/man/bs_dependency.Rd b/man/bs_dependency.Rd
diff --git a/man/bs_get_variables.Rd b/man/bs_get_variables.Rd
diff --git a/man/bs_global_theme.Rd b/man/bs_global_theme.Rd
diff --git a/man/bs_remove.Rd b/man/bs_remove.Rd
diff --git a/man/bs_theme.Rd b/man/bs_theme.Rd
diff --git a/man/bs_theme_dependencies.Rd b/man/bs_theme_dependencies.Rd
diff --git a/man/bs_theme_preview.Rd b/man/bs_theme_preview.Rd
diff --git a/man/precompiled_css_path.Rd b/man/precompiled_css_path.Rd
diff --git a/man/theme_bootswatch.Rd b/man/theme_bootswatch.Rd
diff --git a/man/theme_version.Rd b/man/theme_version.Rd