JuliaControl / ControlSystems.jl

A Control Systems Toolbox for Julia
https://juliacontrol.github.io/ControlSystems.jl/stable/
Other
509 stars 85 forks source link

Rendering of state space equations in documentation #867

Closed albheim closed 1 year ago

albheim commented 1 year ago

See e.g. here, for me the equations for x' and y render on the same line. image

There are multiple other places that seem to have the same problem.

albheim commented 1 year ago

It is also not aligned in the terminal, but less annoying there. image

baggepinnen commented 1 year ago

There's unfortunately a bit of a conflict between having nice rendering in the docs (latex) and in the REPL (no latex) :( In some places, we use code formatting together with unicode to have a bit of a compromise, but for sufficiently complicated things that's just not really feasible. I don't know if something like https://github.com/SimonDanisch/UnicodeFun.jl could be useful to have equations display nice in both places? I've never seen anyone solving this problem before

albheim commented 1 year ago

Yeah, I don't have a good solution. Maybe some REPL tool that detects markdown math-blocks and just "cleans" them somehow. But I don't really mind that much, I just noted it while looking around and thought I would report it quickly.