update_fn_dmt: Update function documentation

update_fn_dmtR Documentation

Update function documentation

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. 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,
  import_from_chr = NA_character_,
  abbreviations_lup,
  fn_types_lup
)

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)

import_from_chr

Import from (a character vector), Default: 'NA'

abbreviations_lup

Abbreviations (a lookup table)

fn_types_lup

Function types (a lookup table)

Value

Function documentation (a character vector of length one)


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