search

brata-hsdc / brata

Automatically exported from code.google.com/p/brata
2 stars 0 forks source link

Improve readability of Station code #75

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
Remove boilerplate comment blocks from methods.  Having no comment is better 
than having a large comment with no information.  Code readability is improved 
when you can see more code.

Also, having that many TODO's overloads the TODO-flagging mechanism in Eclipse, 
making it difficult to see actual TODO's that matter.

See:
https://www.python.org/dev/peps/pep-0257  Docstring Conventions
https://www.python.org/dev/peps/pep-0008  Style Guide for Python Code

I also would have found it helpful to start out with a high-level architectural 
diagram showing the different threads and their roles, and a high-level 
inheritance diagram showing the high-level abstract entities and their concrete 
instantiations.  Any contextual information that would help me as a developer 
to make the initial decisions about how and where to make modifications and 
additions to the station functionality would be a big time-saver and will also 
lead to a more consistently-structured application with less need for review 
and oversight.

Original issue reported on code.google.com by @ellerychan on 3 Mar 2015 at 4:33

jawaad-ahmad commented 9 years ago

Continued on brata-hsdc/brata.station#6.