HelpF`example: helpFunction[$pac$HelpF, addFunction]

Gallery

Tutorial

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.

Section

SECTION: The Webel Doc` package and the HelpF, HelpO`& HelpM` help registry packages

Tags and keywords

Mathematica keywords

Webel Mathematica keywords

Keywords

Before looking at the addFunction function and how it is used to add a function to the HelpF` helpr registry, the next slides show some examples of the help registry in use. This slides shows helpFunction used to get detailed registered help about addFunction:

Click on the image to view it full size

For reference, an associated Policy Note (you don't need to visit this link yet):

Webel: Mathematica: CONVENTION: A 'type$' indicator for an '$opt$' or '$arg$' is for documentation only. It may use a "pattern helper", a human-friendly String, or a SysML-similar short-hand type representation. It need not correspond to a valid Pattern.

Up next

HelpF`example: helpPackage[$pac$HelpF]

Notes

[CONVENTION, NAMING, PATTERN, POLICY]{STRONG} Webel: Mathematica: CONVENTION: A 'type$' indicator for an '$opt$' or '$arg$' is for documentation only. It may use a "pattern helper", a human-friendly String, or a SysML-similar short-hand type representation. It need not correspond to a valid Pattern.

[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: 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$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: 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?

The Webel ‘$t$’ “pseudo type” indicator String convention (for optional additional documentation only)

Related slides (backlinks, includes other tutorials)

HelpF`example: addFunction (1)

HelpF`example: addFunction (2)

HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`

HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)

Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`

Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`

HelpM`: Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help registries

Generate shared option groups using ‘$opt$’ helpers: wl$optsFromOpts, docsFromOpts, rulesFromOpts, and odrMap triplet

HelpF`: OptionsPattern groups as SysML shared between functions

Webel ODR (Options, Docs, Rules) as SysML

Flags