Repository navigation
Cleanup documentation #399
Description
The ModelingToolkitStandardLibrary docs could use a cleanup.
I have spotted the following issues, but there are probably more:
- Several places have missing docstrings. Either these components have been deleted or there are indeed actually missing docstrings. For example, see Digital-Gates
- For some components the description is not formatted correctly, for example: Electrical.PNP
- A different problem with parameters exists here: Electrical.VariableResistor
- For several components the references are missing, for example: Mechanical.Translational.AccelerationSensor is missing references to Flange and RealOutput
- The CI for code formatting is not passing: https://github.com/SciML/ModelingToolkitStandardLibrary.jl/actions/runs/16293870067/job/46010188959
Plenty of QOL and other improvements are also possible and would benefit the documentation.
@ChrisRackauckas this seems like an issue Claude could handle. I have no problem reviewing it, but I don't know how that would work given I have no rights or anything.
Activity
baggepinnen commentedon Jul 25, 2025
You can fork and PR without rights
langestefan commentedon Jul 25, 2025
Yes, I was having a discussion with Chris that he could let claude handle this instead of going through the docs manually. I'm not saying it would necessarily be faster, but I am also kind of curious whether claude could do it. It's a bit of tedious task but should be rather straightforward
Fix documentation issues from #399
ChrisRackauckas commentedon Jul 26, 2025
This is too complex for Claude
langestefan commentedon Jul 26, 2025
I see it did catch a bug in transistors.jl? Interesting