R CMD check issues warnings for #' @usage sections

[maxheld83]

I added options and the (amazing 🙏) boilerplate docs to my package:

#' @eval options::as_roxygen_docs()
NULL

R CMD check does not seem to like the resulting #'@usage tags:

❯ checking for code/documentation mismatches ... WARNING
  Error in vapply(exprs, function(e) as.character(e[[1L]]), "") : 
    values must be length 1,
   but FUN(X[[1]]) result is length 3
  Calls: <Anonymous> -> vapply
  Execution halted

❯ checking Rd \usage sections ... WARNING
  Undocumented arguments in documentation object 'options'
    ‘<name>’ ‘env’ ‘<option>’ ‘<envvar>’
  Objects in \usage without \alias in documentation object 'options':
    ‘c("::", "options", "opt")’ ‘getOption’ ‘Sys.getenv’
  
  Bad \usage lines found in documentation object 'options':
    options("<option>" = <value>)
    Sys.setenv("<envvar>" = <value>)
  
  Functions with \usage entries need to have the appropriate \alias
  entries, and all their arguments documented.
  The \usage entries must correspond to syntactically valid R code.
  See chapter ‘Writing R documentation files’ in the ‘Writing R
  Extensions’ manual.

For now, I'm just stripping out these tags with:

#' Helper to strip out offending usage section from above.
#' @noRd
as_roxygen_docs2 <- function() {
  options::as_roxygen_docs() |> 
    purrr::keep(~ !grepl("@usage", .x))
}

[dgkf]

Thanks for filing! I've been able to reproduce this and will try to get a patch out at some point this weekend.