doc_vars_in_this_func: Document variables and their types that are visibile inside...

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

Description

Call the str() function for all variables visible inside the current function. Before doing that, write out a flag line to indicate the start of a section of output for a particular function and write the call made to that function, i.e., function name followed by its argument list. After writing out the structures of all the variables write out a closing line to flag the end of str() output for the current function.

Usage

doc_vars_in_this_func(sys.call_ht = -1, sys.frame_ht = -1)

Arguments

sys.call_ht	negative integer to pass to sys.call() to specify how high to look on the sys.call stack.
sys.frame_ht	negative integer to pass to sys.frame() to specify how high to look on the sys.frame stack. Generally shouldn't need to set either of the arguments since the value either defaults to the correct value or is set correctly inside doc_vars_in_this_func_once.

Value

Returns nothing

See Also

doc_vars_in_this_func_once

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