add_linters

internal

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

add_linters function

<dl><dt>config</dt>
<dd>A config object to add linters to.</dd>
<dt>tag</dt>
<dd>The name of the tag to which to add linters.</dd>
<dt>linters</dt>
<dd>New linters to add.</dd>
<dt>overwrite</dt>
<dd>A logical value indicating whether existing linters should
be overwritten.</dd></dl>

Arguments

Add linters — add_linters

<dl>

<dt>config</dt>
<dd>A config object to add linters to.</dd>


<dt>tag</dt>
<dd>The name of the tag to which to add linters.</dd>


<dt>linters</dt>
<dd>New linters to add.</dd>


<dt>overwrite</dt>
<dd>A logical value indicating whether existing linters should
be overwritten.</dd>

</dl>

add_linters: Add linters

Description

Usage

Value

Arguments