insightsengineering / insightsengineering/teal.widgets
[Feature Request]: Reorganize `roxygen2` tags
Open
core
documentation
enhancement
- Dominant language
- R
- Stars
- 6
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
During pre-releases of other `teal` packages (e.g. this https://github.com/insightsengineering/teal.modules.general/issues/624) we agreed on a specific order of `roxygen2` tags
Standard order of roxygen2 tags
* `@title ➡️ @doctype ➡️ @description ➡️ @details ➡️ @rdname ➡️`
* `➡️ @inheritParams ➡️ @params ➡️ @return ➡️ @seealso ➡️ @references ➡️`
* `➡️ @examples ➡️ @export ➡️ @keywords ➡️ @noRd`
Apply for this package as well.
Enhancement: consider `@aliases` (just before the `@export`) and `@usage` tag (just after `@description`)
Contributor guide
Assessment
This issue has not been assessed yet.