Clarify that the MSL sets guidelines for itself, but others are free to follow #4253
Conversation
|
Is it related to #4166? |
Modelica/package.mo
Outdated
| @@ -2295,6 +2295,7 @@ Graphical illustrations shall not be added in the diagram layer, but can be adde | |||
| </ul></li> | |||
| <li> These packages should appear in the listed order.</li> | |||
| </ol> | |||
| <p>Other Modelica libraries may also take advantage of these guidelines, for example by referencing this documentation as <code>modelica:/Modelica.UsersGuide.Conventions#info</code>, or by using it as a source of inspiration for an independent set of guidelines.</p> | |||
There was a problem hiding this comment.
Why not a proper href link to the Modelica URI? Or why not linking the resolved (but version pinned one) at https://doc.modelica.org/Modelica%204.0.0/Resources/helpOM/Modelica.UsersGuide.Conventions.html.
There was a problem hiding this comment.
I preferred to just make it a linked Modelica URI in order to stay completely tool agnostic. Good now?
There was a problem hiding this comment.
I also think the internal reference is preferable; not to be tool agnostic but to avoid dependency on possibly changing web-sites.
There was a problem hiding this comment.
@beutlich, OK to resolve?
Not as far as I can tell. |
| @@ -2278,11 +2278,11 @@ Graphical illustrations shall not be added in the diagram layer, but can be adde | |||
| </html>")); | |||
| end Icons; | |||
| annotation (DocumentationClass=true,Documentation(info="<html> | |||
| <p>A Modelica main package should be compliant with the UsersGuide stated in this documentation:</p> | |||
| <p>User-facing packages of the Modelica Standard Library (such as <em>Modelica</em> or <em>Complex</em>) should be compliant with the UsersGuide stated in this documentation:</p> | |||
There was a problem hiding this comment.
To give Modelica as an example doesn't seem right, as it doesn't follow the required package structure.
This is a spinn-off of #4221. By clearly stating that the guidelines are primarily meant for the Modelica Standard Library itself, it is clearly up to the MAP-Lib alone to set the rules.