dynamicslab / pysindy

A package for the sparse identification of nonlinear dynamical systems from data
https://pysindy.readthedocs.io/en/latest/
Other
1.36k stars 305 forks source link

Add Docstring linting #360

Open Jacob-Stevens-Haas opened 1 year ago

Jacob-Stevens-Haas commented 1 year ago

Is your feature request related to a problem? Please describe.

A number of other issues have cropped up (#319, #338, various commits) that relate to arguments being left in docstrings from previous refactors.

Describe the solution you'd like

There's a few precommits out there that can automatically detect these problems, as well as improve type stability of our functions where annotations exist.

Describe alternatives you've considered

See list at https://stackoverflow.com/a/76353158/534674

Additional context

This feels like a good first issue - find one of the above options that works well, put it in .pre-commit-config.yml with appropriate config in pyproject.toml, and PR.