Update docstrings, use numpydoc over napoleon

Gurobi / gurobi-optimods

Data-driven APIs for common optimization tasks

https://gurobi-optimods.readthedocs.io

Apache License 2.0

153 stars 32 forks source link

Closed simonbowly closed 1 year ago

simonbowly commented 1 year ago

Addresses #66

[x] Use numpydoc over napoleon (seems to be cleaner, handles intersphinx properly)
[x] Update intersphinx mappings
[x] Add numpydoc aliases
[x] Update docstrings of (almost all) mods
[x] Update docstring of MVP mod (holding off to avoid conflicts with #84)

rluce commented 1 year ago

Not sure if it does more harm than help, but here is the torturous tool... https://www.pydocstyle.org/en/6.3.0/usage.html

simonbowly commented 1 year ago

Maybe later ... for now it's a wall of warnings, e.g.:

D401: First line should be in imperative mood; try rephrasing (found 'This')