make_fn_desc_spine: Make function description spine

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_fn_desc_spine() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make function description spine. The function returns Function description spine (a character vector of length one).

Usage

make_fn_desc_spine(
  fn_name_1L_chr,
  fn_title_1L_chr,
  fn_type_lup_tb = NULL,
  abbreviations_lup = NULL
)

Arguments

fn_name_1L_chr	Function name (a character vector of length one)
fn_title_1L_chr	Function title (a character vector of length one)
fn_type_lup_tb	Function type lookup table (a tibble), Default: NULL
abbreviations_lup	Abbreviations (a lookup table), Default: NULL

Value

Function description spine (a character vector of length one)

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