Pyomo / pyomo

An object-oriented algebraic modeling language in Python for structured optimization problems.
https://www.pyomo.org
Other
1.97k stars 505 forks source link

Consistent-ifying our doc strings #828

Closed carldlaird closed 1 year ago

carldlaird commented 5 years ago

There are inconsistencies in the code regarding the docstring format (e.g., numpydoc or google). We should decide on the format we prefer and work to move the documentation towards the single format.

Note that this is more than just a style issue since there is significant cleanup required to make sure the docstrings are rendering correctly in the online documentation.

blnicho commented 5 years ago

We had this exact discussion last year: https://groups.google.com/forum/#!searchin/pyomo-developers/numpydoc%7Csort:date/pyomo-developers/_GWsbowflIQ/CzOsmmmgBwAJ

I thought we had settled on numpydoc format but we should probably take an official vote at our next dev meeting.