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
When multiple parameters are documented in a single @param or \arguments{ \item{a, b}{} }, the referent documentation does not include the documentation of that parameter.
Minimal example
#' test function#' This is a test function#' @return A message#'#' @inheritParams testing#'#' @exporttest<-function(b) {
message("This is a test")
}
#' Another test function#' @param a,b character(1) A letter, either lowercase or uppercase#' @return Another message#'#' @exporttesting<-function(a, b) {
message("This is also a test")
}
The test function does not get any generated documentation for argument b even though it inherits the arguments of the testing function which are documented.
@inheritParams now only inherits exact multiparameter matches, so if you're inheriting from a function with @param x,y you'll only get the parameter documentation if your function needs docs for both x and y (#950).
And please don't @ me unless there's some specific urgent issue that I need to be aware of. This is not such an issue.
When multiple parameters are documented in a single
@param
or\arguments{ \item{a, b}{} }
, the referent documentation does not include the documentation of that parameter.Minimal example
The
test
function does not get any generated documentation for argumentb
even though it inherits the arguments of thetesting
function which are documented.Expected behavior
test.Rd
should have the following included:Observed behavior
The
\arguments
section is missing from thetest.Rd
.Roxygen version
RoxygenNote: 7.2.1
Example repository
https://github.com/Link-NY/testPkg
cc: @hadley
The text was updated successfully, but these errors were encountered: