Webel: Mathematica: CONVENTION: A '$doc$' prefix indicates a formatted documentation String helper. A '$doc$arg$' is for an argument, a '$doc$opt$' is for an option. A '$doc$ String may be used to create ::usage documentation via docF.

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

'$doc$'

'$doc$arg$'

'$doc$opt$'

Keywords

This Policy Note concerns '$doc$' documentation String snippets for use in ::usage generation as they apply to Webel '$arg$' and '$opt$' help holders. For more general examples visit:

Webel: Mathematica: CONVENTION: A prefix '$doc' indicates a documentation String for each primary variable/quantity (argument or output)

Relates to

HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help

Doc` package ::usage help generation using the docV and docF functions (1)

Doc` package ::usage help generation using the docV and docF functions (2)

Why the Webel HelpF` & HelpO` registries?

Related notes