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've written a decorator for dplyr functions that does some additional work before handing off to dplyr. I want to inherit the documentation from dplyr, including any documentation of dynamic dots. It seems this is not possible as @inherit or @inheritParams alone will not import named dplyr parameters that are not present in my decorator, and @inheritDotParams will not import dplyr documentation of ... as a parameter. Minimal example as below:
#' Function to be inherited from#'#' I would like parameters `a`, `b` and `...` to be documented in decorator functions below.#'#' @param a param one in function one#' @param b param two in function one#' @param ... important documentation of name value parameters in function one.#'#' @return stuff#' @export#'#' @examples#' print("hi")one=function (a, b, ...) {
}
#' Decorator function calling function one#'#' This does document `a` and `b` from function one, but unfortunately this does#' not document parameter `...` from function one.#'#' @param x param one in function two.#'#' @inherit one#' @inheritDotParams onetwo=function(x, ...) {
# do something with x
one(...)
}
#' Another decorator function calling function one#'#' This does document `...` from function one, but unfortunately does not#' document parameters `a` and `b`#'#' @param y param one in function three.#' @inherit onethree=function(y, ...) {
# do something with y
one(...)
}
N.B. roxygen2 version 7.3.1
Is there any way to inherit everything? I can see there could be potential recursion issues.
The text was updated successfully, but these errors were encountered:
I've written a decorator for
dplyr
functions that does some additional work before handing off todplyr
. I want to inherit the documentation fromdplyr
, including any documentation of dynamic dots. It seems this is not possible as@inherit
or@inheritParams
alone will not import nameddplyr
parameters that are not present in my decorator, and@inheritDotParams
will not importdplyr
documentation of...
as a parameter. Minimal example as below:N.B. roxygen2 version 7.3.1
Is there any way to inherit everything? I can see there could be potential recursion issues.
The text was updated successfully, but these errors were encountered: