Webel ODR (Options, Docs, Rules) as SysML

If you aren't interested in complex Systems Modeling Language (SysMLv1) representations of Wolfram Language code by all means simply skip these slides and visit this slide instead for some more Mathematica-oriented examples!

Click on the image to view it full size

Please note that the ODR Map (Options, Docs, Rules) Association is for lower level packages that only import Doc` (and especially HelpF`). Higher level packages that import the HelpF` or HelpO` packages should instead use an AOR Map (Arguments, Options, Rules) Association that integrates fully with the usageF, addFunction, and addMethod functions.

Up next

HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset

Notes

[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 ...

[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: A help Rule 'rule$opt$' for an '$opt$' (option) accepts keys: '$k$help' (required), '$k$def' (required), and optional '$k$warn', '$k$tip', '$k$lab' (a label), '$k$type' (indicator only), '$k$mult' (SysML multiplicity), and '$k$pat'.

[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: A help Rule 'rule$arg' for an '$arg$' (argument) accepts keys: '$k$help' (required), '$k$def' (required if $k$req = True not given), '$k$req' (True if $k$def not given), '$k$warn', '$k$tip', '$k$lab', '$k$type', '$k$mult' and '$k$pat'

Snippets (quotes/extracts)

Visit also

Visit also (backlinks)

Related slides (includes other tutorials)

Why the Webel HelpF` & HelpO` registries?