Adding "#' @inheritDotParams system" to roxygen comments causes devtools::document() to fail

[naikymen]

Hi, I have no idea why this happens. I'm posting this here in case it helps someone out.

I have the following code in my package:

#' Test the installed cell binary
#' @inheritDotParams system
cell2_test <- function(...){
  system(command = paste(cell2_command(), "-h"), ...)
}

Which causes the following error when I run devtools::document():

Error in FUN(X[[i]], ...) : argument "source" is missing, with no default

Replacing system with base::system fixes the problem.

#' Test the installed cell binary
#' @inheritDotParams base::system
cell2_test <- function(...){
  system(command = paste(cell2_command(), "-h"), ...)
}

The error was cryptic to me. I had to binary-search through my commits with devtools::document() to find the cause. Fortunately the blameful commit did not have many changes.

I'm not sure if this is a bug, but hope that it will be useful to someone at some point.

Thanks for the great software!

[robchallen]

Also just hit this one. minimal reprex:

roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
#' Test
#' @inheritDotParams format
test = function(...) {}
")

Produces cryptic error message.
Whereas:

roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
#' Test
#' @inheritDotParams base::format
test = function(...) {}
")

Works as intended.

The documentation does imply that the namespace prefix is needed, so it is to a certain extent a user error :-).