make_arg_desc_spine: Make argument description spine

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_arg_desc_spine() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make argument description spine. The function is called for its side effects and does not return a value.

Usage

make_arg_desc_spine(
  argument_nm_1L_chr,
  object_type_lup = NULL,
  abbreviations_lup = NULL
)

Arguments

argument_nm_1L_chr	Argument name (a character vector of length one)
object_type_lup	Object type (a lookup table), Default: NULL
abbreviations_lup	Abbreviations (a lookup table), Default: NULL

Value

NA ()

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