server/REVIEW.md

1.2 KiB

Code Review Changes

Original tables with verbatim feedback can be found in this Google Doc.

Comment Adjustment
The models.py file is too difficult to understand. models.py updated with Python docstrings.
The code in general is not commented. Every function in the codebase commented with Python docstring to explain usage and implementation. Some comments added to functions longer than a few lines.
It's difficult to set up the server software. requirements.txt file updated with all packages; default.nix provided via README.md to provide alternative installation method.
No README file. README file added with installation and configuration instructions.
No unit tests. Developed cow description language to test database access (tests still need to be run manually, due to time constraints).
Unrolled list of variables can be converted to list. Unrolled fields kept to maintain isomorphism with hardware, where unrolling variables is necessary due to hardware and radio limitations. Methods written to limit the need for manually accessing coord*x and coord*y variables.