-
Notifications
You must be signed in to change notification settings - Fork 0
Documentation #42
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Fields
Give feedbackNo fields configured for issues without a type.
Documentation is needed in multiple places.
I've opted to use Sphinx to generate the documentation.
We should use numpy style docstrings: https://numpydoc.readthedocs.io/en/latest/format.html
Any functions that are supposed to be "public-facing" should have full docstrings (and probably doesn't hurt to have documentation for other internal functions).
Places that still need documentation:
Work started on docs branch