textlint: Textlint a given file

View source: R/textlint.R

textlintR Documentation

Textlint a given file

Description

Textlint a given file

Usage

textlint(file = NULL, lintrc = ".textlintrc", markers = TRUE, ...)

Arguments

file

filename whose target to textlint

lintrc

file path to .textlintrc. Default, searcing from current directory.

markers

modified output format. If true, the result of lint is displayed in RStudio's marker panel (Only when running with RStudio version higher than 0.99.225).

...

path to other function

Examples

## Not run: 
lint_target <-
  system.file("sample.md", package = "textlintr")
textlint(lint_target)

## End(Not run)

uribo/textlintr documentation built on Oct. 22, 2022, 4:10 a.m.