OpenMDAO / Aviary

NASA's aircraft analysis, design, and optimization tool
https://openmdao.github.io/Aviary/
Other
106 stars 51 forks source link

Create docstrings for all functions present in Aviary API #371

Open jkirk5 opened 4 days ago

jkirk5 commented 4 days ago

Desired capability or behavior.

All Aviary functions accessible through the API need to have properly formatted docstrings, and show up in the docs on the page that automates documenting functions. Ideally every Aviary function should have docstrings to help developers - it's ok if some of them are just one-liners, but there at least needs to be something in a docstring format for IDE's to pick up on.

Docstring formatting is described here: https://peps.python.org/pep-0257/

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

No response

Associated Bug Report

No response