decode_block_start: Start new function block and clean up previous block if...

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

Description

At start of new block of variable descriptions for a new function, write some output to visually separate the new output from the previous block. Also clean up any variable subsection that's still open from the previous block, i.e., write closing brackets for it.

Usage

decode_block_start(prev_state, visual_separator = "\n\n\n\n")

Arguments

prev_state	character string indicating the previous state, e.g., "state__block_start"
visual_separator	character string to write between the end of the previous block and the new block to make it easier to pick out where one ends and the other begins

Value

character string indicating the next state to transition to, e.g., "state__block_start"

See Also

close_open_subsection_if_necessary

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