AguaClara / aide

AguaClara Infrastructure Design Engine - a software tool that designs AguaClara water treatment plants and their components.
MIT License
0 stars 0 forks source link

Review variable naming once MVP is complete #50

Open fletchapin opened 3 years ago

fletchapin commented 3 years ago

At the end of the semester, we should review and unify all the variable naming schemes used throughout the MVP. For example, some places abbreviations are written all uppercase, like JSON, but others they are written Json. In our code, this would look like hlBOD vs HLbod.

fletchapin commented 3 years ago

Monroe pointed out that the casing would have to be intelligently updated for prepending names. E.g. if we want to add lfom to the front of hl, we'd have to capitalize it so it would be lfomHl. However, if we use Monroe's preferred approach that's unnecessary because the variable would already be HL.