Package: roxylint 0.1.0

Doug Kelkhoff

roxylint: Lint 'roxygen2'-Generated Documentation

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.

Authors:Doug Kelkhoff [aut, cre]

roxylint_0.1.0.tar.gz
roxylint_0.1.0.zip(r-4.7-any)roxylint_0.1.0.zip(r-4.6-any)roxylint_0.1.0.zip(r-4.5-any)
roxylint_0.1.0.tgz(r-4.6-any)roxylint_0.1.0.tgz(r-4.5-any)
roxylint_0.1.0.tar.gz(r-4.7-any)roxylint_0.1.0.tar.gz(r-4.6-any)
roxylint_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
roxylint/json (API)

# Install 'roxylint' in R:
install.packages('roxylint', repos = c('https://openpharma.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/openpharma/roxylint/issues

Pkgdown/docs site:https://openpharma.github.io

On CRAN:

Conda:

linterroxygen2

4.00 score 20 stars 212 downloads 14 exports 26 dependencies

Last updated from:a46e491073. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK112
source / vignettesOK170
linux-releaseOK99
macos-releaseOK72
macos-oldrelOK76
windows-develOK71
windows-releaseOK55
windows-oldrelOK51
wasm-releaseOK82

Exports:check_linterdemo_taglint_full_stoplint_no_full_stoplint_sentence_caselint_starts_lowercaselint_title_caseregister_lintersroxylinttidytidy_paramtidy_returntidy_seealsotidy_title

Dependencies:brewcallrclicommonmarkcpp11descevaluatefsgluehighrknitrlifecycleotelpkgbuildpkgloadprocessxpsR6rdtoolsrlangroxygen2rprojrootwithrxfunxml2yaml

Readme and manuals

Help Manual

Help pageTopics
Apply 'roxygen2' linterscheck_linter check_linter.character check_linter.default check_linter.function check_linter.list
Get that tag!demo_tag
Assorted linterslinters lint_full_stop lint_no_full_stop lint_sentence_case lint_starts_lowercase lint_title_case tidy tidy_param tidy_return tidy_seealso tidy_title
Register linters for new tagsregister_linters
Roclet for 'roxygen2' style lintingroxylint