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
Policy level
Mathematica keywords
Webel Mathematica keywords
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:
Relates to
Related notes
Related notes (backlinks)
Related snippets (extracts)
Visit also
Visit also (backlinks)