Diagnose Examples That Run Nothing

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

diagnose_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.

See also

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

Examples

pkg <- example_diagnose_scenario("code_examples/tf_usage_bad.R",
                                 show_content = FALSE)
diagnose_commented_examples(pkg, verbose = FALSE)$passed
#> [1] TRUE