various docs enhancements

R/basic_table_args.R

@@ -46,7 +46,7 @@ basic_table_args <- function(...) {
 #'  module creator setup for [rtables::basic_table()] of a specific table.
 #'  Created with the [basic_table_args()] function. The `NULL` value is supported.
 #' @param app_default (`basic_table_args`)\cr
-#'  teal option variable. The `NULL` value is supported.
+#'  an option variable. The `NULL` value is supported.
 #'
 #' @return `basic_table_args` object.
 #' @details
@@ -102,7 +102,7 @@ resolve_basic_table_args <- function(user_table = basic_table_args(),
 #'     user_default = basic_table_args(title = "DEFAULT_TITLE", subtitles = "SUBTITLE")
 #'   )
 #' )
-parse_basic_table_args <- function(basic_table_args = teal.widgets::basic_table_args()) {
+parse_basic_table_args <- function(basic_table_args = basic_table_args()) {
   checkmate::assert_class(basic_table_args, "basic_table_args", null.ok = TRUE)
 
   if (length(basic_table_args) == 0) {

R/ggplot2_args.R

@@ -61,7 +61,7 @@ ggplot2_args <- function(labs = list(), theme = list()) {
 #'  module creator setup for theme and labs in the specific plot.
 #'  Created with the [ggplot2_args()] function. The `NULL` value is supported.
 #' @param app_default (`ggplot2_args`)\cr
-#'  teal option variable. The `NULL` value is supported.
+#'  an option variable. The `NULL` value is supported.
 #'
 #' @return `ggplot2_args` object.
 #'

R/optionalInput.R

@@ -421,12 +421,12 @@ optionalSliderInput <- function(inputId, label, min, max, value, label_help = NU
   }
 }
 
-#' For teal modules we parameterize an \code{optionalSliderInput} with one argument
+#' For `teal` modules we parameterize an \code{optionalSliderInput} with one argument
 #' \code{value_min_max}
 #'
 #' @description `r lifecycle::badge("stable")`
 #' The [optionalSliderInput()] function needs three arguments to decided
-#' whether to hide the `sliderInput` widget or not. For teal modules we specify an
+#' whether to hide the `sliderInput` widget or not. For `teal` modules we specify an
 #' optional slider input with one argument here called `value_min_max`.
 #'
 #' @inheritParams optionalSliderInput

R/standard_layout.R

@@ -2,7 +2,7 @@
 #' the left
 #'
 #' @description `r lifecycle::badge("stable")`
-#' This is the layout used for the teal modules in the `beam` package
+#' This is the layout used for the `teal` modules.
 #'
 #' @param output (`shiny.tag`)\cr
 #'   object with the output element (table, plot, listing) such as for example returned
@@ -35,7 +35,7 @@ standard_layout <- function(output,
     "post_output" = post_output
   ))) {
     if (!is.null(l[[name]]) && !inherits(l[[name]], c("shiny.tag", "shiny.tag.list", "html"))) {
-      stop(paste(name, "is supposed to be NULL, shiny.tag or shiny.tag.list."))
+      stop(paste(name, "is supposed to be `NULL`, `shiny.tag` or `shiny.tag.list`."))
     }
   }
 

R/teal.widgets-package.R

@@ -1,7 +1,7 @@
-#' teal.widgets: Custom widgets for teal applications
+#' `teal.widgets`: Custom widgets for `teal` applications
 #'
 #' The `teal.widgets` package contains functionalities that can be used
-#' for teal module development. The Package is dedicated to allow developers to extend modules
+#' for `teal` module development. The package is dedicated to allow developers to extend modules
 #' functionality by additional inputs and output controls.
 #'
 #' @keywords internal