Description Usage Arguments Value Classification Author(s) Examples
View source: R/interpretResults.R
Interpret results of ManualPageBuilder
1 | interpretResults(manualPageGenerationResults_l)
|
manualPageGenerationResults_l |
A |
Provides output that allows to know which sections has been generated and which sections are missing or probably missing.
This function checks for presence of content that should be present in a well formated and documented function manual page. It provides hints. You could follow those hints to produce great documentation.
When producing a manual page using ManualPageBuilder
, keeping
the result in a R variable (see examples below) allows you to interpret this
result at any time in the future. This is helpful when working incrementally
to produce a fully automated generation scheme for a given manual page.
STRATUM ▶ LAYER_3
PHASING ▶ RUN
INTENT ▶ QUALITY_CONTROL
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
1 2 3 4 5 6 7 8 9 10 11 | ic <- InputContext(NULL, 'append', packageName_s_1 = 'wyz.code.rdoc')
res <- produceManualPage(ic)
# WARNING: File /tmp/RtmpYIampA/append.Rd
# checkRd: (5) /tmp/RtmpYIampA/append.Rd:0-19: Must have a \description
interpretResults(res)
# filename is /tmp/RtmpYIampA/append.Rd [OVERWRITTEN]
# generated 8 sections: name, alias, title, usage, arguments, author, keyword, encoding
# missing 3 sections: description, value, examples
# probably missing 1 section: details
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.