update_fn_dmt: Update function documentation

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

update_fn_dmt() is an Update function that edits an object, while preserving core object attributes. Specifically, this function implements an algorithm to update function documentation. Function argument fn_tags_spine_ls specifies the object to be updated. Argument new_tag_chr_ls provides the object to be updated. The function returns Function documentation (a character vector of length one).

Usage

update_fn_dmt(
  fn_tags_spine_ls,
  new_tag_chr_ls,
  fn_name_1L_chr,
  fn_type_1L_chr,
  import_chr,
  abbreviations_lup = NULL
)

Arguments

fn_tags_spine_ls	Function tags spine (a list)
new_tag_chr_ls	New tag (a list of character vectors)
fn_name_1L_chr	Function name (a character vector of length one)
fn_type_1L_chr	Function type (a character vector of length one)
import_chr	Import (a character vector)
abbreviations_lup	Abbreviations (a lookup table), Default: NULL

Value

Function documentation (a character vector of length one)

readyforwhatsnext/ready4fun documentation built on Nov. 22, 2020, 9:28 p.m.