diff_requires_run_roxygenize: Check if we should run roxygen.

In precommit: Pre-Commit Hooks

Check if we should run roxygen.

Description

This is the case if a new or replaced/removed line contains a roxygen2 comment in a file that is staged. This function is only exported for use in hook scripts, but it's not intended to be called by the end-user directly.

Usage

diff_requires_run_roxygenize(root = ".")

Arguments

root	The root of the git repo.

Value

A logical vector of length 1.

See Also

Other hook script helpers: dirs_R.cache(), may_require_permanent_cache(), precommit_docopt(), robust_purl(), roxygen_assert_additional_dependencies(), roxygenize_with_cache()

Examples

## Not run: 
diff_requires_run_roxygenize()

## End(Not run)

precommit documentation built on Sept. 11, 2024, 7:07 p.m.