write_pkg_api: Write the pkg API to disk

Description Usage Arguments

View source: R/write_pkg_api.R

Description

Exported functions from a package (along with their arguments and any associated default values) are printed to a file.

Usage

1
write_pkg_api(..., filename = "pkg_api")

Arguments

...

Any objects pointing to a package location. This can be a string with a path to a local package directory, or, an invocation of a helper function such as [from_github()].

filename

The output filename for the text to be written to disk.


rich-iannone/pkgattrs documentation built on July 28, 2020, 7:42 p.m.