Skip to content

Inheriting from other packages can create broken links #635

Description

@karawoo

When using @inheritDotParams to inherit documentation from another package, any links in the documentation to other functions in that package will broken. A reprex:

library("roxygen2")
roc_proc_text(rd_roclet(), "
  #' Title
  #'
  #' @inheritDotParams maps::map database
  wrapper <- function(...) maps::map(...)"
  )
#> $wrapper.Rd
#> % Generated by roxygen2: do not edit by hand
#> % Please edit documentation in RtmpentfmJ/file11179684a1b94
#> \name{wrapper}
#> \alias{wrapper}
#> \title{Title}
#> \usage{
#> wrapper(...)
#> }
#> \arguments{
#>   \item{...}{Arguments passed on to \code{maps::map}
#>   \describe{ \item{database}{ character string
#>   naming a geographical database, a list of \code{x},
#>   \code{y}, and \code{names} obtained from a previous
#>   call to \code{map} or a spatial object of class
#>   \code{SpatialPolygons} or \code{SpatialLines}.
#>   The string choices include a \code{\link{world}}
#>   map, three USA databases (\code{\link{usa}},
#>   \code{\link{state}}, \code{\link{county}}), and more (type
#>   \code{help(package='maps')} to see the package index).
#>   If the requied database is in a different package that
#>   has not been attached, the string may be started with
#>   "packagename::". The location of the map databases may be
#>   overridden by setting the \code{R_MAP_DATA_DIR} environment
#>   variable. } }}
#> }
#> \description{
#> Title
#> }

Things like \link{world} should be \link[maps:world]{world} to pass R CMD check.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions