anschelburk / nutrient_guide

Apache License 2.0
0 stars 0 forks source link

Code style #31

Closed bbelderbos closed 8 months ago

bbelderbos commented 8 months ago
          For variable names I would refrain from using types / names of data structures as variable names.

This is also known as the Hungarian notation, see: https://en.wikipedia.org/wiki/Hungarian_notation

Try to use business logic names, for example the names we see on the page: dict1 could be my_current_nutrients and dict2 could be target_nutrients

This makes the code easier to read / reason about.

_Originally posted by @bbelderbos in https://github.com/anschelburk/PDM-Nutrient_Guide/pull/27#discussion_r1514330335_

bbelderbos commented 8 months ago

This issue is for later, no a prio, to address some of this feedback

anschelburk commented 8 months ago

Thank you. Took a look, happy to use this notation moving forward.