Documentation is incomplete

Jordan-Prescott / odins_spear

Python library for Odin's API to build and manage Broadworks installations.

https://docs.jordan-prescott.com/odins_spear

MIT License

6 stars 1 forks source link

Documentation is incomplete #44

Closed Jordan-Prescott closed 1 month ago

Jordan-Prescott commented 2 months ago

Huge chunks of the docstrings are missing or do not follow the correct format. Furthermore, the online docs are also missing for all methods that are in the docs.

Need to:

Identify all docs inconsistences and correct
Identify missing docs in code and online docs
Write missing docs

Jordan-Prescott commented 1 month ago

All docs have been correct and added to online docs.