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
CRAN (and Bioconductor) wish that all cross-references were anchored (And testing via a new environmental variable).
I was checking the current state of CRAN's cross references and I found out that some of my own cross-references were missing the anchor (See for example the source and the output). This happens when they are generated with #' @family group.
library(roxygen2)
roc_proc_text(rd_roclet(), " #' Title1 #' #' See [bar()] #' @family check #' @md foo <- function() {} #' Title2 #' #' @family check bar <- function() {}"
)
#> $foo.Rd#> % Generated by roxygen2: do not edit by hand#> % Please edit documentation in ./<text>#> \name{foo}#> \alias{foo}#> \title{Title1}#> \usage{#> foo()#> }#> \description{#> See \code{\link[=bar]{bar()}}#> }#> \seealso{#> Other check: #> \code{\link{bar}()}#> }#> \concept{check}#> #> $bar.Rd#> % Generated by roxygen2: do not edit by hand#> % Please edit documentation in ./<text>#> \name{bar}#> \alias{bar}#> \title{Title2}#> \usage{#> bar()#> }#> \description{#> Title2#> }#> \seealso{#> Other check: #> \code{\link{foo}()}#> }#> \concept{check}
I'm not sure how it handles multiple topics in the same file after #1109 or how to find the right topic on the rd-family.R, but fixing this will eventually help solve a note from packages that use roxygen2.
The text was updated successfully, but these errors were encountered:
Apologies, I think they are not needed in this case (yet?) because the links are always to topics in the same package and CRAN doesn't complain about it.
I am not sure if then the anchors are needed according to the documentation. I leave it open in case this helpful or you want to harmonize both ways have links.
CRAN (and Bioconductor) wish that all cross-references were anchored (And testing via a new environmental variable).
I was checking the current state of CRAN's cross references and I found out that some of my own cross-references were missing the anchor (See for example the source and the output). This happens when they are generated with
#' @family group
.Created on 2024-08-27 with reprex v2.1.1
I think the root cause is that it is handled different than in other cases where links are created (as in markdown it works well), see:
roxygen2/R/rd-family.R
Lines 56 to 60 in 9652d15
Different from:
roxygen2/R/object-import.R
Lines 36 to 41 in 9652d15
I'm not sure how it handles multiple topics in the same file after #1109 or how to find the right topic on the rd-family.R, but fixing this will eventually help solve a note from packages that use roxygen2.
The text was updated successfully, but these errors were encountered: