r4ss icon indicating copy to clipboard operation
r4ss copied to clipboard

use `@inheritParams` instead of `@template`

Open iantaylor-NOAA opened this issue 1 year ago • 0 comments

@inheritParams is what tidyverse seems to use. This same issue is on {ss3sim} (originally having come from nmfs-stock-synthesis/workflows) of https://github.com/ss3sim/ss3sim/issues/408

Use @inheritParams instead of template folder for roxygen of arguments that are shared across parameters.

This approach is documented in

  • https://r-pkgs.org/man.html#inheriting-arguments and
  • https://cran.r-project.org/web/packages/roxygen2/vignettes/reuse.html

iantaylor-NOAA avatar May 25 '23 17:05 iantaylor-NOAA