write_all_fn_dmt: Write all function documentation

write_all_fn_dmtR Documentation

Write all function documentation

Description

write_all_fn_dmt() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write all function documentation. The function returns a S4 methods (a list).

Usage

write_all_fn_dmt(
  pkg_setup_ls,
  fns_env_ls,
  document_unexp_lgl = F,
  fns_dmt_tb = deprecated()
)

Arguments

pkg_setup_ls

Package setup (a list)

fns_env_ls

Functions (a list of environments)

document_unexp_lgl

Document unexported (a logical vector), Default: F

fns_dmt_tb

Functions documentation (a tibble), Default: deprecated()

Value

a S4 methods (a list)


ready4-dev/ready4fun documentation built on April 22, 2024, 8:33 a.m.