Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
naikymen opened this issue Mar 20, 2024 · 0 comments

Comments

@naikymen
Copy link

naikymen commented Mar 20, 2024

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!

@jennybc jennybc transferred this issue from r-lib/devtools Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant