Skip to contents

Inspect Rd file titles

Source: R/check_rd_titles.R
check_rd_titles.Rd

Checks generated Rd file titles for sentence case and trailing periods.

Usage

check_rd_titles(pkg = ".")

Arguments

pkg

Path to the package root directory.

Value

A data frame with one row per Rd file and columns for the source path, title, sentence-case title, final character and sentence-case check. Returns NULL if no Rd files are found.

See also

update_docs() runs this check after roxygenizing the package.

Examples

# \dontrun{
check_rd_titles()
#> ℹ No Rd files found in ./man.
#> NULL
# }