Readable code should be prioritised over comments.
Where necesary block comments in the form:
Variable names to be relevant to their intended purpose and named in the form:
function names to follow same convention as variables:
When defining lists or passing many parameters to functions,
place individual parameters on separate lines for readability and
in general try to adhere to Python's recommended maximum line length.
Lists should be formatted as shown below:
Console output should be performed through the logging python package as opposed to print(x).
All unused variables and all unnecesary logging to be removed BEFORE commiting to git unless specifically required.
Full code coverage tests to be added as soon as possible following function completion, all unreachable code must be removed. For proper format see tests\test_example_name.py
Test files should be placed in the test directory and names should be preffixed with test_ as shown here:
Running open_audio_controller_test.py will automatically import and run all tests in the test directory providing code coverage at the bottom:
