52 standardise optional notation (#1121)

part of insightsengineering/nestdevs-tasks#52

---------

Signed-off-by: kartikeya kirar <[email protected]>
Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: Aleksander Chlebowski <[email protected]>

R/init.R

@@ -31,8 +31,8 @@
 #'   The header of the app.
 #' @param footer (`shiny.tag` or `character(1)`)
 #'   The footer of the app.
-#' @param id (`character`)
-#'   Optional string specifying the `shiny` module id in cases it is used as a `shiny` module
+#' @param id (`character`) optional
+#'   string specifying the `shiny` module id in cases it is used as a `shiny` module
 #'   rather than a standalone `shiny` app. This is a legacy feature.
 #'
 #' @return Named list with server and UI functions.

R/modules.R

@@ -395,7 +395,7 @@ is_arg_used <- function(modules, arg) {
 #' Nesting it increases overall depth by 1.
 #'
 #' @inheritParams init
-#' @param depth optional, integer determining current depth level
+#' @param depth optional integer determining current depth level
 #'
 #' @return Depth level for given module.
 #' @keywords internal

R/show_rcode_modal.R

@@ -8,8 +8,8 @@
 #'  Title of the modal, displayed in the first comment of the `R` code.
 #' @param rcode (`character`)
 #'  vector with `R` code to show inside the modal.
-#' @param session (`ShinySession` optional)
-#'  `shiny` session object, if missing then [shiny::getDefaultReactiveDomain()] is used.
+#' @param session (`ShinySession`) optional
+#'  `shiny` session object, defaults to [shiny::getDefaultReactiveDomain()].
 #'
 #' @references [shiny::showModal()]
 #' @export

R/teal_slices.R

@@ -9,7 +9,7 @@
 #'
 #' @inheritParams teal.slice::teal_slices
 #'
-#' @param module_specific optional (`logical(1)`)
+#' @param module_specific (`logical(1)`) optional,
 #'  - `FALSE` (default) when one filter panel applied to all modules.
 #'  All filters will be shared by all modules.
 #'  - `TRUE` when filter panel module-specific.

R/utils.R

@@ -80,7 +80,7 @@ teal_data_to_filtered_data <- function(x, datanames = teal_data_datanames(x)) {
 #'
 #' @param title (`character(1)`) title of the card (unless overwritten by label)
 #' @param label (`character(1)`) label provided by the user when adding the card
-#' @param description (`character(1)`) optional additional description
+#' @param description (`character(1)`) optional, additional description
 #' @param with_filter (`logical(1)`) flag indicating to add filter state
 #' @param filter_panel_api (`FilterPanelAPI`) object with API that allows the generation
 #' of the filter state in the report