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

Webel IT Australia promotes the amazing Mathematica tool and the powerful Wolfram Language and offers professional Mathematica services for computational computing and data analysis. Our Mathematica tips, issue tracking, and wishlist is offered here most constructively to help improve the tool and language and support the Mathematica user community.
DISCLAIMER: Wolfram Research does not officially endorse analysis by Webel IT Australia.
Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
NAMING
PATTERN
POLICY
Policy level
STRICT
Mathematica keywords
String
Rule
Association
Webel Mathematica keywords
help holder
'$k$help'
'$k$warn'
'$k$def'
'$k$tip'
'$k$req'
'$k$lab'
'$k$pat'
'$k$mult'
'$opt$'
'$info$opt$'
'$lab$opt$'
'$warn$opt$'
'$tip$opt$'
'rule$opt$'
Keywords

The LHS of a help Rule for a '$opt$' options is its corresponding '$opt$' help holder name (such as '$opt$doShow', '$opt$doDebug', '$arg$pac$myOpt'). The RHS is an Association with the listed keys.

The '$k$' keys for simplicity (because used so often) bend the usual Webel recommendations slightly, in that the keys for $k$help$', '$k$warn$', '$k$tip$', '$k$lab$' etc. do not explicitly indicate that their values are Strings (so not $k$$help$', '$k$$warn$', '$k$$tip$', '$k$$lab$' etc.).

The key '$k$help' maps from '$info$opt$', which may appear slightly inconsistent, but note that '$info$opt$' is used in other contexts, and in this context, it provides a help String.

For '$opt$' options, the optional '$k$mult$' UML/SysML-style multiplicity indicator String (used only for documentation) - which maps from '$mult$opt$' - is rarely used.

For '$opt$' options, the optional pattern helper key '$k$pat' - which maps from ''$pat$opt$' - is also rarely used.

For examples of use visit:
Make a Webel option help Rule relying on ‘$opt$’ naming conventions
SECTION: Webel coding and naming conventions for the Wolfram Language
Relates to
The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"
Make a Webel option help Rule relying on ‘$opt$’ naming conventions
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset
HelpF`: Pull Mathematica Options[] for a function registered with addFunction
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
Related notes
[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'
[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$'..
[CONVENTION, NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: Where keys of Associations are Strings they are encapsulated as variables prefixed with '$k$' (promotes DRY and has many advantages, such as IDE prompting). Direct use of "Strings" as keys is WET and strongly discouraged!
Related notes (backlinks)
Related snippets (extracts)
Visit also
SECTION: Webel coding and naming conventions for the Wolfram Language
Visit also (backlinks)