Webel '$arg$' and '$opt$' support via the Doc` package

Please note that at this stage we are only examining use of the Webel '$opt$' help holders conventions in lower-level packages, which rely on "manual" naming conventions; in later slides we'll see how Webel extensions of MTools for OO such as the MOpt class can be used to encapsulate the help holders for the Webel options convention.

We'll also see how higher level packages can use an AOR Map (Arguments, Options, Rules) Association to help automate use of '$opt$' help holders and Wolfram Language Options[], for registration with the HelpF` (package functions) and HelpO` (class methods) help systems. and for highly automated, structured ::usage generation.

Lower level packages do have some degree of support for structured ::usage generation through the docV and docF functions, but higher level packages can use the far more powerful and much easier usageF function.

Up next

Functions from the W`Base`Doc` package

Notes

[NAMING, OPTION, PATTERN, TIP]{OPTION} Mathematica: Webel: You CAN/MAY use $ in variable names and function names - just not as the first character before a Capital - and it's extremely useful. You won't get sent to Azkaban prison if do you use a $ character!

[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: Argument help holders use a String variable with the prefix '$arg$', a related '$info$arg$' String, a 'def$arg$' default value expression and/or 'req$arg$', and optional '$warn$arg$', '$tip$arg$, '$lab$arg$', 'type$arg$'..

[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: Option help holders use a String variable with the prefix '$opt$', a related '$info$opt$' String, a 'def$opt$' default value expression, and optional '$warn$opt$', '$tip$opt$', '$lab$opt$', and 'type$opt$' indicator ...

[POLICY]{STRONG} About the Single Source of Truth (SSOT) and Don't Repeat Yourself (DRY) principles

Snippets (quotes/extracts)

Visit also

The Webel SysML4Mathematica recipe for modelling Wolfram Language code in Systems Modeling Language (SysML) for Model-Based Systems Engineering

Visit also (backlinks)

Related slides (includes other tutorials)