insightsengineering / insightsengineering/teal.widgets
[Feature Request]: Revisit `@param` + `@return` tags and lifecycle badges
- Dominant language
- R
- Stars
- 6
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
A follow-up after https://github.com/insightsengineering/teal.widgets/issues/149
# `@param`
- Revisit `optional` phrase usage in `@param`.
- Revisit if we put dots at the end of `@param` description or not.
- Revisit if we always do (and maybe we should not) have a class name after `@param` and then a newline `\cr` . Other packages not necessarily have the `\cr`
# `@return`
- Revisit `@return` tag so they do not contain a class specification and then the repetition of the class name in a sentence, like
```r
#' @return (`shiny::tagList`) A `shiny tagList`.
```
in `get_dt_rows`
# lifecycle badges
- Check if every function has the badge.
- Check if every badge is in a separate line of the description (use `\cr`).
Contributor guide
Assessment
This issue has not been assessed yet.