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

Set LAPACK's html documentation into the 'pre' environment #4404

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

tobolar
Copy link
Contributor

@tobolar tobolar commented May 7, 2024

The documentation of Modelica's LAPACK functions was obviously done by copy/paste from the original LAPACK's Fortran routines, but without setting it in the HTML environment. So the rendering of the documentation is tool-dependent and, to my Dymola-restricted knowledge, messy (which doesn't mean I expect Dymola shall format this better!).
So the suggested PR sets the documentation into the pre environment to make a look of the original Ascii documentation.

Additionally, documentation was improved in:

  • dgelsy_vec
  • dgetrs_vec

@tobolar tobolar added the documentation Issue addresses the documentation label May 7, 2024
@tobolar tobolar marked this pull request as draft May 7, 2024 12:45
@tobolar tobolar marked this pull request as ready for review May 7, 2024 13:30
@beutlich beutlich added the L: Math Issue addresses Modelica.Math label May 7, 2024
@casella
Copy link
Contributor

casella commented Jun 22, 2024

@tobolar can you please comment on what is the goal of this PR and suggest some reviewers? Otherwise it risks remaining stuck forever.

Copy link
Contributor

@maltelenz maltelenz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good improvement, rather than relying on tools to somehow automatically detect these need special rendering.

I'm assuming the <, > replacements were done in some search and replace manner, so I didn't check them all.

@tobolar
Copy link
Contributor Author

tobolar commented Jun 26, 2024

@tobolar can you please comment on what is the goal of this PR and suggest some reviewers? Otherwise it risks remaining stuck forever.

I have changed the description of this PR.

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: Math Issue addresses Modelica.Math
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants