r - avoiding warning with CRAN check -
i have r package code like:
#' ...lots of roxygen documentation... fn <- function(long, list, of=optional, arguments=optional) {...} ... #' @export #' @rdname fn %f% <- fn
where %f% call fn(long, list).
this gives warning when checked r cran check
:
* checking code/documentation mismatches ... warning codoc mismatches documentation object 'refset': %f% code: function(long, list, of=optional, arguments=optional) docs: function(long, list) argument names in code not in docs: of=optional, arguments=optional
i not write separate function %f%
, since add code complexity. documentation
usage ... long %f% list
as now, since indeed how %f%
should called. there way keep cran robot happy without confusing users , doing stupid stuff?
Comments
Post a Comment