completeManualPage: Complete Manual Page
In neonira/wyz.code.rdoc: Wizardry Code Offensive Programming R Documentation

Description Usage Arguments Value Classification Author(s) Examples

Complete a manual page

1 2	completeManualPage(filename_s_1, processingContext_o, add_b_1 = TRUE, verbosity_b_1 = FALSE)

`filename_s_1`	A single string value
`processingContext_o`	See `ProcessingContext`. Only `postProcessing_l` parameter is considered by this function.
`add_b_1`	add flag. When `TRUE` add content to existing content. Otherwise patch content.
`verbosity_b_1`	verbosity flag

This function adds or patches on-demand sections of a manual page file.

You may consider twice prior using this function. It is a convenience that aims to sustain your productivity. You may get very quick results using it, but at the probable cost of non reproducibility in comparison with manual pages produced using function ManualPageBuilder.

STRATUM ▶ LAYER_3

PHASING ▶ RUN

INTENT ▶ CONTENT_GENERATION

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

f <- function() {}
ic <- InputContext(NULL, 'f')
p <- produceManualPage(ic)
# WARNING: File /tmp/Rtmpvk4BG5/f.Rd
# checkRd: (5) /tmp/Rtmpvk4BG5/f.Rd:0-9: Must have a \description


completeManualPage(p$context$filename,
   ProcessingContext(postProcessing_l = list(
      details = function(content_s) 'some more details',
      concept = function(content_s) 'yet another concept'
   )), verbosity = TRUE
)
# adding details
# adding concept
# [1] TRUE