register_linters

A registration mechanism for other packages to provide linters, either for
custom tags or to implement their own linting styles.

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

register_linters function

<dl><dt>...</dt>
<dd>Linters to register, with parameter names used to identify the
associated tag.</dd>
<dt>linters</dt>
<dd>Optionally, provide a named list of linters directly.</dd>
<dt>.overwrite</dt>
<dd>Whether existing linters should be overwritten. Intended to
be used sparingly. For example, this could be used to implement an entire
new style guide without inheriting defaults.</dd></dl>

Arguments

Register linters for new tags — register_linters

<dl>

<dt>...</dt>
<dd>Linters to register, with parameter names used to identify the
associated tag.</dd>


<dt>linters</dt>
<dd>Optionally, provide a named list of linters directly.</dd>


<dt>.overwrite</dt>
<dd>Whether existing linters should be overwritten. Intended to
be used sparingly. For example, this could be used to implement an entire
new style guide without inheriting defaults.</dd>

</dl>

register_linters: Register linters for new tags

Description

Usage

Value

Arguments