search

modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.
https://doc.modelica.org
BSD 3-Clause "New" or "Revised" License
481 stars 169 forks source link

Class name as text in Diagram in Electrical.Analog #4186

Open maltelenz opened 1 year ago

maltelenz commented 1 year ago

A lot of the examples in Modelica.Electrical.Analog.Examples have a large Text item on the Diagram basically replicating the information of the class name.

Other sub-libraries in MSL don't have this, and any tool would presumably show the class name somewhere close when showing the diagram, so replicating this information on the diagram only adds clutter.

Would a pull request removing these Text items be accepted?

HansOlsson commented 1 year ago

It is also inconsistently done in that package; which makes it less useful.

However, note that even if Modelica.Electrical.Analog.Examples.ResonanceCircuits has texts in a similar style I think they should be kept (and such texts should be encouraged), whereas Modelica.Electrical.Analog.Examples.ShowVariableResistor has a text that is roughly the class name.

maltelenz commented 1 year ago

It is also inconsistently done in that package; which makes it less useful.

However, note that even if Modelica.Electrical.Analog.Examples.ResonanceCircuits has texts in a similar style I think they should be kept (and such texts should be encouraged), whereas Modelica.Electrical.Analog.Examples.ShowVariableResistor has a text that is roughly the class name.

I agree with everything you say here. There are definitely cases where text on diagrams can be used for good things, like in ResonanceCircuits. I would not want to remove those cases.