What documentation should we have, and what would we like to have?
We currently have docstrings on everything(?), but these require either reading through the code, or knowing what the classes/methods are called to check them with pydoc.
Possible improvements include:
- API documentation on a webpage. We could see how gusto / irksome / defcon do things.
- Manual pages on a webpage.
- Overview of asQ / library aims
- Library structure / design philosophy
- Explanations of the various modules and example uses
- FAQ / troubleshooting
- Jupyter notebooks with serial examples
What documentation should we have, and what would we like to have?
We currently have docstrings on everything(?), but these require either reading through the code, or knowing what the classes/methods are called to check them with
pydoc.Possible improvements include: