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'

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
Keys
Values
Webel Mathematica keywords
'$arg$'
'$info$arg$'
'def$arg$'
'type$arg$'
'$warn$arg$'
help holder
'$pat$'
$pat$arg$'
'$tip$arg'
'rule$arg$'
'req$arg'
'$k$help'
'$k$warn'
'$k$def'
'$k$tip'
'$k$req'
'$k$lab'
'$k$mult'
Keywords

The LHS of a help Rule for a '$arg$' argument is its corresponding '$arg$' help holder name (such as '$arg$doShow', '$arg$doDebug', '$arg$pac$myArg'). 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.).

If '$k$def' is given, '$k$req = False' is assumed by help rule makers, and any inconsistencies are reported as errors.

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

The optional '$k$mult$' UML/SysML-style multiplicity indicator String (used only for documentation) maps from '$mult$arg$'.

For examples of use visit:
Webel ‘$arg$’, ‘def$arg$’, and ‘rule$arg$’ convention
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"
Webel ‘$arg$’, ‘def$arg$’, and ‘rule$arg$’ convention
Make a Webel help Rule for a required ‘$arg$’ argument + conventions
Make a Webel argument help Rule with a default by convention OR override
Webel $arg$ convention help consistency checks
Webel ‘rule$arg$’ convention help consistency checks
Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage
When to use explicit $arg$ help holders (in lower level utility packages)
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
HelpO`: addMethod: MTools method registration example for the Webel MAll class and an object
Webel ODR (Options, Docs, Rules) as SysML
Related notes
[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)