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

Dead Modelica URI link in documentation #3937

Closed
henrikt-ma opened this issue Jan 21, 2022 · 1 comment · Fixed by #3939
Closed

Dead Modelica URI link in documentation #3937

henrikt-ma opened this issue Jan 21, 2022 · 1 comment · Fixed by #3939
Assignees
@dietmarw
Labels
documentation Issue addresses the documentation L: Electrical.Machines Issue addresses Modelica.Electrical.Machines
Milestone
MSL4.1.0

Comments

@henrikt-ma
Copy link
Contributor

A dae link like this causes problems for those that try to keep their documentation free of dead links:

ModelicaStandardLibrary/Modelica/Electrical/Machines/Thermal/package.mo

Line 140 in 8345852

<h5><!--<a href=\"modelica://Modelica.Electrical.Machines.BasicMachines.DCMachines.DC_Compound\">-->DC machine with compound excitation (not yet implemented)<!--</a>--></h5>

This is the only case I'm aware of. Any chance we could avoid pointing to non-existing classes like this?
@henrikt-ma henrikt-ma added L: Electrical.Machines Issue addresses Modelica.Electrical.Machines documentation Issue addresses the documentation labels Jan 21, 2022
@dietmarw
Copy link
Member

I agree that including links to future planned implementation (or just mentioning them) is a bad idea since it creates a false expectation which (as shown in the past of MSL) often could not be satisfied in the end.

In addition, the "dead" link you pointed uncovers a slightly larger mistake of not having correctly removed (outcommented) the following text section that belongs to the defunct h5 heading. I'm going to create a PR to get rid of the whole superfluous section.

@dietmarw dietmarw added this to the MSL4.1.0 milestone Jan 21, 2022
@dietmarw dietmarw self-assigned this Jan 21, 2022
dietmarw added a commit to dietmarw/ModelicaStandardLibrary that referenced this issue Jan 21, 2022
@dietmarw
Remove section that points to possible future implementation
c3f80f4 
Fixes modelica#3937
Documentation should state what **is** implemented and not point to something that *might* get implemented. Here this resulted also in a list without heading.
@dietmarw dietmarw mentioned this issue Jan 21, 2022
Merged
beutlich pushed a commit that referenced this issue Feb 1, 2022
@dietmarw
Remove section that points to possible future implementation (#3939)
ddacf12 
Fixes #3937
Documentation should state what **is** implemented and not point to something that *might* get implemented. Here this resulted also in a list without heading.
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: Electrical.Machines Issue addresses Modelica.Electrical.Machines
Projects
None yet
Milestone
MSL4.1.0
Development

Successfully merging a pull request may close this issue.

Remove commented Modelica URI link in documentation with list dietmarw/ModelicaStandardLibrary
2 participants
@dietmarw @henrikt-ma