odrMap
A Webel Mathematica libraries function from the Doc` package. Generates a "triplet" ODR Map Association for any number of given Webel convention option help holder '$opt$' vars (with HoldAll). Has keys mapping to each of a Lists of Wolfram Language Options Rules (key '$k$wl$opts'), a List of '$doc$' ::usage
Snippet Strings (key '$k$docs'); and (key 'k$opts') an Association of Webel 'rule$opt$' help Rules . Offers a degree of DRY reuse of help and options information in lower-level packages (without relying on MTools).
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.For full help integration using MTools visit MArg, MOpt, MFunction, MClass, and MMethod.
HelpF`: OptionsPattern groups as SysML shared between functions
This content has been marked as discussing an ADVANCED topic!