Aviary icon indicating copy to clipboard operation
Aviary copied to clipboard

Create docstrings for all functions present in Aviary API

Open jkirk5 opened this issue 1 year ago • 1 comments

Desired capability or behavior.

All Aviary functions accessible through the API need to have complete and properly formatted docstrings (numpy format), 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 minor function/class docstrings 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/, https://numpydoc.readthedocs.io/en/latest/format.html

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

No response

Associated Bug Report

No response

jkirk5 avatar Jun 28 '24 14:06 jkirk5

#508 adds docstrings to most functions & classes. Important docstrings (accessible through api.py) need complete docstrings with attributes, methods, etc. fully documented. Automated docs page that pulls docstrings from everything in api.py is needed.

jkirk5 avatar Sep 25 '24 18:09 jkirk5