demo_tag

Tools for inspecting <code><a href="https://roxygen2.r-lib.org/reference/roxy_tag.html">roxygen2::roxy_tag()</a></code>s. This can be helpful for
exploring the intermediate tag objects. For example, you can use this
function to generate a tag and explore the named values in <code>$val</code>.

Provides formatting linting to 'roxygen2' tags. Linters report
'roxygen2' tags that do not conform to a standard style. These linters
can be a helpful check for building more consistent documentation and
to provide reminders about best practices or checks for typos. Default
linting suites are provided for common style guides such as the one
followed by the 'tidyverse', though custom linters can be registered by
other packages or be custom-tailored to a specific package.

Doug Kelkhoff

roxylint

Lint 'roxygen2'-Generated Documentation

demo_tag function

<dl><dt>str</dt>
<dd>A 'roxygen2' tag string.</dd></dl>

Arguments

Tools for inspecting <code><a href='https://roxygen2.r-lib.org/reference/roxy_tag.html'>roxygen2::roxy_tag()</a></code>s. This can be helpful for
exploring the intermediate tag objects. For example, you can use this
function to generate a tag and explore the named values in <code>$val</code>.

Get that tag! — demo_tag

<dl>

<dt>str</dt>
<dd>A 'roxygen2' tag string.</dd>

</dl>

demo_tag: Get that tag!

Description

Usage

Value

Arguments

Examples