doc_vars_in_this_func_once: Document function's variables a limited number of times

In langfob/docaids: Package For Helping Document Local Variables In R

Description

This is a wrapper function for doc_vars_in_this_func. It makes sure that doc_vars_in_this_func is only run once in a given invocation of a program, no matter how many times the function containing the doc_vars_in_this_func call is called. This is useful in avoiding getting a bunch of duplicate outputs for the same function when it is called more than once in a program.

Usage

doc_vars_in_this_func_once(max_ct = 1,
  ctr_name_prefix = "TEMPCTR___RM_THIS_AT_END__")

Arguments

max_ct	integer maximum number of times to write the documentation for a function, no matter how many times it's called
ctr_name_prefix	character string to prepend to function name when building a counter name that is supposed to be unique

Value

Returns nothing

See Also

doc_vars_in_this_func for the main action of this routine

doc_vars_in_this_func_once for explanation about ctr_name_prefix, which you will probably never touch

langfob/docaids documentation built on May 20, 2019, 7:56 p.m.