Skip to main content

Module doc_pkg_links

Module doc_pkg_links 

Source
Expand description

Doc links into R packages the package does not declare.

  • MXL204: roxygen2 reads [`Type::method`], [Type::method] and [text][pkg::topic] as a link into the R package named before the last ::, and warns “refers to un-installed package” when there is none. The link was usually written for rustdoc. This rule warns on each pkg:: link in #[miniextendr] docs whose pkg is not the package itself, not in Depends / Imports / Suggests / Enhances / LinkingTo, and not shipped with R. Leading prose counts only under roxygen_prose_links = "keep": the default strips its links. A block that renders no help page (@noRd, noexport) does not count at all: the macro strips every link there (#1818). The rule reports and never rewrites. It skips when there is no DESCRIPTION.

Functions§

check