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

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
Specification keywords
Keywords

$doc$psy$mDot$a = vDoc[
 "mDot$a",
 "Mass flow rate of the dry air component (constant between states under steady state)."
];

$doc$psy$mDot$wat$i$g = vDoc[
 "mDot$wat$i",
 "Mass flow rate of water VAPOUR (gas) added TO the humid air mixture."
];

$doc$psy$w1 = vDoc[
 "w1",
 "Humidity ratio of State1 (initial)."
];

$doc$psy$w2 = vDoc[
 "w2",
 "Humidity ratio of State2 (final)."
];

Note how the documentation String is generated via a utility method vDoc that formats the variable name and documentation String (or Strings) thus:


$doc$psy$mDot$a

- mDot$a: Mass flow rate of the dry air component (constant between states under steady state).

This convention works together with:

Relates to
Related notes
Related notes (backlinks)
Related snippets (extracts)
Visit also
Visit also (backlinks)