Skip to content

Commit ea3f729

Browse files
committed
docs: first try at changing documentation for decorators arg
1 parent 7b8b8c0 commit ea3f729

14 files changed

+181
-27
lines changed

R/utils.R

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,19 @@
2525
#' with text placed before the output to put the output into context. For example a title.
2626
#' @param post_output (`shiny.tag`) optional, text or UI element to be displayed after the module's output,
2727
#' adding context or further instructions. Elements like `shiny::helpText()` are useful.
28-
#' @param decorators `r lifecycle::badge("experimental")` (`list` of `teal_transform_module` or `NULL`) optional,
28+
#' @param decorators `r lifecycle::badge("experimental")`
29+
#' (`list` of `teal_transform_module`,
30+
#' named `list` of `teal_transform_module` or
31+
#' `NULL`) optional,
2932
#' if not `NULL`, decorator for tables or plots included in the module.
33+
#' When a named list of `teal_transform_module`, the decorators are applied to the
34+
#' outputs of the corresponding view of the module.
35+
#' Otherwise, the decorators are applied to all outputs in all views equally, which is the same
36+
#' as using the name `default`.
37+
#'
38+
#' A module can have different views with different outputs, such as a tab with
39+
#' a table and another with a plot.
40+
#' See section "Decorating `tm_<module_name>`" below for more details.
3041
#'
3142
#' @param alpha (`integer(1)` or `integer(3)`) optional, specifies point opacity.
3243
#' - When the length of `alpha` is one: the plot points will have a fixed opacity.

man/shared_params.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_a_pca.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_a_regression.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_data_table.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_g_association.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_g_bivariate.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_g_distribution.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_g_response.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_g_scatterplot.Rd

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)