csc301-2023-fall / project-34-qeynet-inc-t

Repository for Astra, a U of T CSC301 team project developed for QEYnet.
MIT License
0 stars 1 forks source link

Standardize style and formatting #35

Open shape-warrior-t opened 8 months ago

shape-warrior-t commented 8 months ago

Although we did adhere to some broad standards in terms of code style, there are still various places where things can be made more homogeneous. Notably, although docstrings (should generally) conform to reST, there's some variation in things like how to distinguish variables in text and the specifics of how whitespace is used. Perhaps it could be worth using an autoformatter (Ruff has worked pretty well for me) over the entire codebase.

On a related note, the current unit tests use a mixture of unittest (self.assertEqual(a, b) and similar inside methods of unittest.TestCase subclasses) and pytest (assert a == b and similar) styles -- probably a good idea to standardize on one style.