Skip to contents

Convert roxygen2 documentation links to Markdown

Source: R/pal.gen.R
roxy_to_md_links.Rd

Converts roxygen2 documentation links in pseudo-Markdown style to actual Markdown ones using downlit::autolink_url().

Usage

roxy_to_md_links(x)

Arguments

x

Markdown text with roxygen2 documentation links. A character scalar.

Value

A character scalar.

See also

Other package documentation functions: enum_fn_param_defaults(), fn_param_defaults(), roxy_blocks(), roxy_obj(), roxy_tag_value()

Examples

pal::roxy_to_md_links("[base::c()] is so short I almost forget it's there.")
#> Error: 'md_ns' is not an exported object from 'namespace:tinkr'
pal::roxy_to_md_links("[`base::c()`], probably the most used base R function ever.")
#> Error: 'md_ns' is not an exported object from 'namespace:tinkr'
pal::roxy_to_md_links("Some functions [are magic][downlit::autolink_url]!")
#> Error: 'md_ns' is not an exported object from 'namespace:tinkr'
pal::roxy_to_md_links("downlit's [`autolink_url()`][downlit::autolink_url] seems magic!")
#> Error: 'md_ns' is not an exported object from 'namespace:tinkr'