search

EMSTrack / Algorithms

BSD 3-Clause "New" or "Revised" License
1 stars 0 forks source link

Denote "private" helper methods by adding single underscore #32

Open hansyuan opened 5 years ago

hansyuan commented 5 years ago

From Google search:

The underscore prefix is meant as a hint to another programmer that a variable or method starting with a single underscore is intended for internal use. This convention is defined in PEP 8. This isn't enforced by Python. Python does not have strong distinctions between “private” and “public” variables like Java does.

We should follow this practice as it may become confusing to know which methods to call as development furthers

hansyuan commented 5 years ago

While we're at it with this, the classes need comments, at least a class header for each class