hytech-racing / MCU

https://hytech-racing.github.io/MCU/index.html
GNU General Public License v3.0
0 stars 0 forks source link

Unify Coding Conventions #23

Closed CL16gtgh closed 5 months ago

CL16gtgh commented 7 months ago
walkermburns commented 7 months ago

To expand on this: we need to comb through the codebase and decide on similar naming schemes for functions and variables just to improve readability.

This is most noticeable with our CAN read and write functions, some interfaces use read and write, others use get and enqueue, this should ideally all be the same. Another example is with ticking functions, the function names should include the tick frequency for the eventuality that multiple parts of the same interfaced are ticked at different rates.

This can be part of a cleanup effort after we have stabilized the code functionality.