Create docstrings for all functions present in Aviary API
@nathanperreau is already working on this.
Since Feb 11, 2026.
- Dominant language
- Python
- Stars
- 287
- Forks
- 140
- Avg merge
- 6d 14h
- Merged PRs (30d)
- 18
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.