insightsengineering / teal.modules.general

General Purpose Teal Modules

https://insightsengineering.github.io/teal.modules.general/

Other

9 stars 13 forks source link

Update to roxygen2 `@template` for `ggplot2_args` arguments #694

Closed averissimo closed 8 months ago

averissimo commented 8 months ago

Pull Request

Closes #695
Part of #624

Changes description

Update type in ggplot2_args
Minor change to phrasing
Move template file under man page to avoid extra folder at root level (available since roxygen2@7.0.0)
Update .Rbuildignore accordingly

Reviewer should consider

@template has been superseded (https://roxygen2.r-lib.org/articles/reuse.html?q=template#superseded)
- There's no equivalent though (with parameterized strings)
- Alternative: we could add ggplot2_args to shared_params and specific list of names it can take in @details on each function that uses this

averissimo commented 8 months ago

R CMD check, {lintr} and {styler} pass