Diagnose Single-Quoted Function Names — lab_description_function_quotes • checktor

Flags a single-quoted function name in Title/Description. Single quotes are reserved for software names.

Usage

lab_description_function_quotes(path = ".", verbose = TRUE, desc = NULL)

Arguments

path: Character. Path to the package directory. Default: ".".
verbose: Logical. Print diagnostic output. Default: TRUE.
desc: Optional pre-parsed DESCRIPTION, as returned by base::read.dcf(). Defaults to reading it from path.

Value

checktor_check_result() with passed, issues, message.

Source

No rule. This was an invented rule and is kept callable but off by default. See vignette("check-sources", package = "checktor") for how every check maps to its source.

See also

checktor(), which runs this and every other check.

Examples

pkg <- example_diagnose_scenario("description_examples/description_function_quotes_bad.txt",
                                 show_content = FALSE)
lab_description_function_quotes(pkg, verbose = FALSE)$issues
#> [1] "Description: function name 'deff()' should not be quoted"
#> [2] "Description: function name 'ess()' should not be quoted" 
unlink(pkg, recursive = TRUE)