jobatabs / ratio Goto Github PK

Project downloaded 29.4.2023 (12:45).

Software Requirements Specification is clear and well-laid out and it even includes a plan for the graphical user interface, great!

While the software is somewhat simple, it has an excellent build structure, and module names are logical. All classes follow a unified naming style and most of the classes and functions have already the Docstring documentation included, nice! Awesome Class Diagram included within the software documentation!

Some modules and/or functions are missing documentation (see "calculations.py", probably just because it's a work-in-progress). While I think the specified module (calculations) is simple enough to be understood rather quickly, I'd suggest keeping the documentation uniform to match the course standards; why is the module important, and what purpose does it serve?

In general, it's easy and satisfying to read the software code, everything is written out so well! It's easy to understand the functionality of any specific code and debugging is just that much easier. All tests run successfully with 100% coverage, excellent!

If you wish to strive for the maximum points, I'd suggest implementing the long-term memory functionality you've mentioned in the Software Requirements Specification. 4 points out of the total 24 are still determined by the complexity of long-term memory functionality.

Overall, the code is top-notch and it's safe to say it meets the course's quality requirements without trouble. Good job, keep it going!