Overriding descriptions in modifiers #2237
Description
Reported by hansolsson on 2 Mar 2018 11:31 UTC
The semantics of description strings on modifiers should be clarified.
One interpretation is that they are descriptions of the modifications themselves (this is used in e.g. Dymola), another is that (if present) they override the description of the original element (used in Simulation X) - and is thus used in e.g. parameter dialogs, summary of connectors, and in tooltips.
The latter seems useful, e.g.:
block Division "Output first input divided by second input"
extends Modelica.Blocks.Interfaces.SI2SO(
u1 "Dividend",u2 "Divisor", y "Quotient u1 / u2");
equation
y = u1/u2;
end Division;
It does not seem as overriding description will cause an overhead in an implementation, since it is just one string or the other and no additional lookup or scoping.
Obviously if the description string is missing from the modifier nothing is changed. Redeclarations might need further investigation.
Based on modelica/ModelicaStandardLibrary#2471 (comment)
Migrated-From: https://trac.modelica.org/Modelica/ticket/2237