From 5796d011850784dba32e9d3bdfe35041a5701dab Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Fri, 15 May 2020 21:44:00 -0700 Subject: [PATCH] Add code review remarks. --- REVIEW.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 REVIEW.md diff --git a/REVIEW.md b/REVIEW.md new file mode 100644 index 0000000..f24c228 --- /dev/null +++ b/REVIEW.md @@ -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.|