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!

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

'$k$'

Keywords

In the Webel coding recipe for the Wolfram Language and Mathematica String keys for Associations are encapsulated as String variables prefixed with '$k$', which promotes DRY coding and has many other advantages, such as IDE prompting.

Direct use of "Strings" as Association keys is WET and strongly discouraged!

Note that this policy does not state that Associations MUST use Strings as keys in all Associations, just that where Strings are indeed used they SHOULD be encapsulated as '$k$' String variables.

For some '$k$' usage examples visit:

Visit also: The Webel $k$ prefix convention for Association String keys

The '$k$' convention is often used together with these Webel help holder conventions:

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

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

Webel: Mathematica: CONVENTION: "pattern helpers" (which are not themselves Patterns) use the prefix '$pat$. Encapsulated Patterns use a 'pat$' prefix, and may use a '$pat$' pattern helper (such as an Alternatives).

EXAMPLE: The Webel help Rule system used to register '$opt$' and '$arg$' help holders with the HelpF` and HelpO` help registries uses the '$k$' key convention.

There is a detailed technical slide trail describing how the Webel naming conventions for Wolfram Language code work together:

Visit also: SECTION: Webel coding and naming conventions for the Wolfram Language

Relates to

The Webel ‘$’ prefix convention for Strings and "String similar" Wolfram Language code

The Webel $k$ prefix convention for Association String keys

The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"

Related notes