CS-46X/server
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add code review remarks.

Browse Source
This commit is contained in:
Danila Fedorin 2020-05-15 21:44:00 -07:00
parent e497686460
commit 5796d01185
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
REVIEW.md Normal file
View File

@ -0,0 +1,9 @@
# Code Review Changes
|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](https://dev.danilafe.com.CS-46x/cdl.git) 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.|