Skip to content

Commit

Permalink
feat: add template for decorators parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
averissimo committed Nov 29, 2024
1 parent e7132b5 commit 444cd0b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions R/roxygen2_templates.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# nocov start
roxygen_decorators_param <- function(module_name) {
paste(
sep = " ",
lifecycle::badge("experimental"),
" (`list` of `teal_transform_module`, named `list` of `teal_transform_module` or",
"`NULL`) optional, if not `NULL`, decorator for tables or plots included in the module.",
"When a named list of `teal_transform_module`, the decorators are applied to the",
"respective output objects.\n\n",
"Otherwise, the decorators are applied to all objects, which is equivalent as using the name `default`.\n\n",
sprintf("See section \"Decorating `%s`\"", module_name),
"below for more details."
)
}
# nocov start

0 comments on commit 444cd0b

Please sign in to comment.