matt-dray / snorkel Goto Github PK

You can use Markdown in roxygen function documentation, as per the {roxygen2} guidance.

Some of these are like normal Markdown, like backticks for code, but others are less obvious, like the [text][ref] format.

Perhaps use different function suffixes for the md vs rd approaches, like md_*() and roxy_*() or whatever.

Would probably want a new section in the reference tab of the pkgdown site as well.

In {quartostamp} I added to @details the exact text that would be placed in the document and to @sources a link to the guidance docs online (e.g. for stamp_columns()).

Should do the same here.

Using rd_fn_other_pkg() on package::function results in \code{\link[package]{function}} as expected.

But if you don't highlight any text before using the function, you get: \code{\link[}}, i.e. ]{ are missing from the middle.

Perhaps want a separate print statement when text hasn't first been selected.

Ensure the correct wording is used throughout the package. Like @details is a roxygen tag and\emph{} would be an Rd tag, right? Check this.