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
Just been asked by CRAN to fix documentation in my package, which generated the following warnings:
Found the following HTML validation problems:
p_mutate.html:56:1 (p_mutate.Rd:17): Warning: trimming empty <dt>
This seems to be a new check and were the result of me using @inheritDotParams where there were no additional parameters to inherit. For example:
#' A base function#'#' @param x a parameter#' @param ... not used at present but might be extended in the future#'#' @return something#' @export#'#' @examples#' print("hi")test_fn_one=function(x, ...) {
}
#' @param y additional parameter#' @inherit test_fn_one#' @inheritDotParams test_fn_onetest_fn_two=function(x, y, ...) {
# do something with y
test_fn_one(x, ...)
}
Generates a test_fn_two.Rd file that contains the following .Rd:
<snip>
\item{...}{
Arguments passed on to \code{\link[=test_fn_one]{test_fn_one}}
\describe{
\item{\code{}}{}
}}
}
<snip>
The empty \describe block seems to cause CRAN issues. I can work around this by removing the @inheritDotParams directive in test_fn_two but that breaks future proofing for changes in test_fn_one. Is there another way to approach this?
Many thanks. N.B. issue [#1670 ] is I think a connected problem.
The text was updated successfully, but these errors were encountered:
robchallen
added a commit
to robchallen/roxygen2
that referenced
this issue
Oct 18, 2024
Just been asked by CRAN to fix documentation in my package, which generated the following warnings:
This seems to be a new check and were the result of me using
@inheritDotParams
where there were no additional parameters to inherit. For example:Generates a
test_fn_two.Rd
file that contains the following .Rd:The empty
\describe
block seems to cause CRAN issues. I can work around this by removing the@inheritDotParams
directive intest_fn_two
but that breaks future proofing for changes intest_fn_one
. Is there another way to approach this?Many thanks. N.B. issue [#1670 ] is I think a connected problem.
The text was updated successfully, but these errors were encountered: