search

inspectorG4dget / AnonymousFeedback

1 stars 0 forks source link

Add documentation #43

Closed scriptbae closed 7 years ago

scriptbae commented 7 years ago

Currently, most of the code and API are undocumented. Critically, this includes very small comment coverage, and a lack of JSdoc and PyDoc coverage in the codebase.

The web API should likewise be documented.

scriptbae commented 7 years ago

Documentation is being applied progressively to the client-side JavaScript as well as to backend.py and dbhandler.py during the major refactor of the management script.

This will not result in 100% documentation coverage, but constitutes a significant contribution to the progress of this issue.