Code quality needs improvement
-
Refactoring: sharedvalues renamed to sharedvariables (needs to be checked everywhere) -
Refactoring: remove MP in class, function names (so DatarecorderMP should just be DataRecorder) -
Docstrings needs to be added in all important functions, and per class (perhaps best done in pairs) -
#TODO in the code need to be checked, removed if not important, or fixed, or added as issue if need changes you are not sure of (Pycharm gives an overview of all TODO's in a project) -
all random debug print statements need to go -
commented unused code needs to be removed -
all files need to adhere to PEP8 ( Ctrl+Alt+L
in Pycharm). -
Check all 'yellow' underlining in Pycharm (these often point to problems or spelling errors, etc). -
Pycharm sometimes thinks that there are spelling mistakes in class names (e.g Datarecorder -> Recorder is it's own word, shoyld be DataRecorder).
List of modules/maps to do:
-
Core (most baseclasses such as ModuleManager etc) -
Template -
HardwareManager -
CarlaInterface -
DataRecorder -
HapticControllerManager -
ControllerPlotter -
Experiment manager
UPDATE We will have a joined look at this with all developers on the 4th of December 15:00 - 17:00