Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What is the usage recommendation for class? #2128

Closed
modelica-trac-importer opened this issue Jan 15, 2017 · 2 comments
Closed

What is the usage recommendation for class? #2128

modelica-trac-importer opened this issue Jan 15, 2017 · 2 comments
Assignees
Labels
documentation Issue addresses the documentation L: ModelicaReference Issue addresses ModelicaReference
Milestone

Comments

@modelica-trac-importer
Copy link

modelica-trac-importer commented Jan 15, 2017

Since 09e4eae, in ModelicaReference.Classes.'class' the usage recommendation of "class" is given by

"class" should only be used to define ExternalObject

However, "class" is frequently used troughout MSL, ModelicaServices and ModelicaReference as non-specialized class with annotation DocumentationClass=true.

The DocumentationClass annotation was controversially discussed and introduced in #1062 (back in 2013 for MLS 3.2r2), but as 09e4eae originates from 2010, I believe it was overlooked to adapt the class recommendation for ModelicaReference.


Migrated-From: https://trac.modelica.org/Modelica/ticket/2128

@modelica-trac-importer modelica-trac-importer added the invalid Invalid issue label Jan 15, 2017
@beutlich beutlich changed the title Placeholder What is the usage recommendation for class? Mar 26, 2018
@beutlich beutlich added L: ModelicaReference Issue addresses ModelicaReference and removed invalid Invalid issue labels Mar 26, 2018
@beutlich beutlich added this to the MSL3.2.3 milestone Mar 26, 2018
@beutlich beutlich reopened this Mar 26, 2018
@akloeckner
Copy link

This is related to: #1860

@HansOlsson
Copy link
Contributor

Ok, I understand it now: unless/until we have a specialized documentation-class then "class" seems like the preferred option for a documentation-class, and the ModelicaReference should indicate that.

@beutlich beutlich added the documentation Issue addresses the documentation label Apr 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue addresses the documentation L: ModelicaReference Issue addresses ModelicaReference
Projects
None yet
Development

No branches or pull requests

5 participants