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.

Sign up for GitHub

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

Jump to bottom

ModelicaReference.Annotations.Documentation contains unresolvable URIs #2721

Closed
svorkoetter opened this issue Oct 2, 2018 · 2 comments
Closed

ModelicaReference.Annotations.Documentation contains unresolvable URIs #2721

svorkoetter opened this issue Oct 2, 2018 · 2 comments
Assignees
@dietmarw
Labels
documentation Issue addresses the documentation L: ModelicaReference Issue addresses ModelicaReference
Milestone
MSL3.2.3

Comments

@svorkoetter
Copy link
Contributor

The documentation in ModelicaReference.Annotations.Dialog contains two instances of modelica://Multibody.... I believe these should be modelica://Modelica/Multibody/... to resolve correctly.
@svorkoetter svorkoetter changed the title ModelicaReference.Annotations.Dialog contains unresolvable URIs ModelicaReference.Annotations.Documentation contains unresolvable URIs Oct 2, 2018
@sjoelund
Copy link
Member

sjoelund commented Oct 3, 2018

ModelicaStandardLibrary/ModelicaReference/package.mo

Line 760 in 467a0b6

<a href=\"modelica://MultiBody.Tutorial\">MultiBody.Tutorial</a>

is not a link though. It could refer to anything, and I suppose in this instance it referred to the old MultiBody library. I suppose this link should be modelica://Modelica.Mechanics.MultiBody.UsersGuide.Tutorial to resolve correctly (didn't check MSL to see the new location).

@dietmarw
Copy link
Member

dietmarw commented Oct 3, 2018

Yes that location is correct. But it does not have to be an existing Package in this *example snippet. I will supply a PR which changes this to a URI that does not indicate an existing package.

dietmarw pushed a commit to dietmarw/ModelicaStandardLibrary that referenced this issue Oct 3, 2018
@usn-student
Fixes modelica#2721 by using a more abstract package as example
1d90470 
The previous example URI suggested something that should actually exist. But in this case this is just meant to serve as an example for documentation. This makes this clear.
@dietmarw dietmarw added the documentation Issue addresses the documentation label Oct 3, 2018
@dietmarw dietmarw added this to the MSL_next-MAJOR-version milestone Oct 3, 2018
@dietmarw dietmarw self-assigned this Oct 3, 2018
@beutlich beutlich added the L: ModelicaReference Issue addresses ModelicaReference label Oct 3, 2018
dietmarw added a commit to dietmarw/ModelicaStandardLibrary that referenced this issue Oct 4, 2018
@dietmarw
Fixes modelica#2721 by using a more abstract package as example
c7649ce 
The previous example URI suggested something that should actually exist. But in this case this is just meant to serve as an example for documentation. This makes this clear.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dietmarw dietmarw

Labels
documentation Issue addresses the documentation L: ModelicaReference Issue addresses ModelicaReference
Projects
None yet
Milestone
MSL3.2.3
Development

No branches or pull requests
4 participants
@dietmarw @sjoelund @beutlich @svorkoetter