Skip to contents

Diagnose Examples That Run Nothing

Source: R/diagnostics-documentation.R
lab_commented_examples.Rd

Flags an \examples{} block whose only content is commented out, so it demonstrates nothing. A comment beside live code is illustration and is not flagged.

Usage

lab_commented_examples(path, verbose = TRUE)

Arguments

path

Character. Path to the package directory. Default: ".".

verbose

Logical. Print diagnostic output. Default: TRUE.

Value

checktor_check_result() with passed, issues, message.

Source

No formal rule. An \examples{} block that is entirely commented out demonstrates nothing, a convention which is why this sits at opinion tier. 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("code_examples/tf_usage_bad.R",
                                 show_content = FALSE)
lab_commented_examples(pkg, verbose = FALSE)$passed
#> [1] TRUE