In some places of the code, we are using the variable names that are nor self-descriptive, nor really documented. Example:
# main.py
g = Graph()
g.load_graph(...)
In the above piece of code the developer can come up with an idea on what the g stands for, but if the code will become bigger and structured like this, we won't be able to identify which this variable stands for. 😕
We should either use more self-descriptive names, like:
graph = Graph()
graph.load_graph(...)
or document those variables.
This problem exists in all of the project files, we should really think about fixing it.
In some places of the code, we are using the variable names that are nor self-descriptive, nor really documented. Example:
In the above piece of code the developer can come up with an idea on what the
gstands for, but if the code will become bigger and structured like this, we won't be able to identify which this variable stands for. 😕 We should either use more self-descriptive names, like:or document those variables.
This problem exists in all of the project files, we should really think about fixing it.