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

Fix documentation of Translational User's Guide #2813

Closed
christiankral opened this issue Jan 23, 2019 · 2 comments · Fixed by #2867
Closed

Fix documentation of Translational User's Guide #2813

christiankral opened this issue Jan 23, 2019 · 2 comments · Fixed by #2867
Assignees
@tobolar
Labels
documentation Issue addresses the documentation L: Mechanics.Translational Issue addresses Modelica.Mechanics.Translational
Milestone
MSL4.0.0

Comments

@christiankral
Copy link
Contributor

Some documentation issue apply to:

  • Modelica.Mechanics.Translational.UsersGuide.Overview
  • Modelica.Mechanics.Translational.UsersGuide.SignConventions
  • Modelica.Mechanics.Translational.UsersGuide.UserDefinedComponents

The documentation text refers to:

  • component m1
  • component m2

Example:
image

The depicted figures however show the components mass1 and mass2. On my opinion this is misleading, as the shown component names of the figures and the text shall match. Otherwise it has to be explained what m1 and m2 are compared to mass1 and mass2. This shall be fixed.
@christiankral christiankral added the documentation Issue addresses the documentation label Jan 23, 2019
@christiankral christiankral added this to the maintenance milestone Jan 23, 2019
@christiankral christiankral added L: Mechanics.Translational Issue addresses Modelica.Mechanics.Translational V: 3.2.3-beta.2 Issue originates in MSL v3.2.3-beta.2 (and is not present in earlier releases) labels Jan 23, 2019
@beutlich beutlich removed the V: 3.2.3-beta.2 Issue originates in MSL v3.2.3-beta.2 (and is not present in earlier releases) label Jan 24, 2019
@beutlich
Copy link
Member

I removed the V: 3.2.3-beta.2 label since the issue also is present in earlier MSL versions and did not originate in V: 3.2.3-beta.2.

@beutlich beutlich modified the milestones: maintenance, MSL4.0.0 Jan 24, 2019
@beutlich
Copy link
Member

beutlich commented Jan 24, 2019 •
edited

I changed the milestone to MSL4.0.0 since this is not a severe issue that needs back-porting for MSL 3.2.3.

@tobolar tobolar mentioned this issue Mar 28, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tobolar tobolar

Labels
documentation Issue addresses the documentation L: Mechanics.Translational Issue addresses Modelica.Mechanics.Translational
Projects
None yet
Milestone
MSL4.0.0
Development

Successfully merging a pull request may close this issue.

Upgrade user's guide
3 participants
@christiankral @tobolar @beutlich