Skip to content

Autolinking with markdown functions does not produce the correct .Rd #1579

@olivroy

Description

@olivroy

On the website, it implies that [geom_point()][ggplot2::geom_point()] will link it as code.

however, with roxygen2 7.3.0, here is what I get with Roxygen: list(markdown= TRUE)

In short, according to the docs, I would expect.

#' [geom_point()][ggplot2::geom_point()]

\code{\link[ggplot2:geom_tile]{geom_tile()}}, but it does \link[ggplot2:geom_point]{geom_point()} instead.

Contrary to what the docs say, I actually need to use back ticks.

#' [`geom_point()`][ggplot2::geom_point()]

gives the correct result.

Side note:

I tried following the advice in SUPPORT.md, but roc_proc_text() does not appear to support markdown input?

library(roxygen2)
roc_proc_text(rd_roclet(), "
  #' Title
  #' 
  #' [geom_point()][ggplot2::geom_point()]
  #'
  #' [`geom_point()`][ggplot2::geom_point()]
  #' @export
  foo <- function() {}
  "
)
#> $foo.Rd
#> % Generated by roxygen2: do not edit by hand
#> % Please edit documentation in ./<text>
#> \name{foo}
#> \alias{foo}
#> \title{Title}
#> \usage{
#> foo()
#> }
#> \description{
#> [geom_point()][ggplot2::geom_point()]
#> }
#> \details{
#> [`geom_point()`][ggplot2::geom_point()]
#> }

Created on 2024-01-22 with reprex v2.1.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions