You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I really like @inheritParams and @inherit but StackOverflow seems to think roxygen2 does not support inheriting docs from parameters where the source name does not match that of the target.
I also have not seen any open or closed issues referring to this issue in this repo, so I thought I'd ask.
Say I have a documentation template
#' Commonly used parameters#'#' @keywords internal#' @name params-template#'#' @param example_param Has a definition.#' @param other_example_param Has a different definition.NULL
How can the docs for parameter example_param for example_fun() inherit the documentation from the non-matching parameter other_example_param from params-template?
Is there a solution that looks like this that I'm not aware of?
#' @inheritFrom source components param
Thank you so much in advance for your help and for your work on the package.
The text was updated successfully, but these errors were encountered:
I really like
@inheritParams
and@inherit
but StackOverflow seems to think roxygen2 does not support inheriting docs from parameters where the source name does not match that of the target.I also have not seen any open or closed issues referring to this issue in this repo, so I thought I'd ask.
Say I have a documentation template
and a function
How can the docs for parameter
example_param
forexample_fun()
inherit the documentation from the non-matching parameterother_example_param
fromparams-template
?Is there a solution that looks like this that I'm not aware of?
#' @inheritFrom source components param
Thank you so much in advance for your help and for your work on the package.
The text was updated successfully, but these errors were encountered: