Skip to contents

Diagnose ::: in Examples

Source: R/diagnostics-examples.R
lab_example_internal_ns.Rd

Flags a pkg:::fn() call in an example. The triple colon reaches an unexported object, whose behaviour the author is free to change, so CRAN asks for one colon or for the object to be exported.

Usage

lab_example_internal_ns(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

CRAN sends this back verbatim as "Using foo:::f instead of foo::f allows access to unexported objects ... Please omit one colon", listing the .Rd files it appears in. See vignette("check-sources", package = "checktor") for how every check maps to its source.

See also

checktor(), lab_unexported_example_ns().

Examples

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