let's get rid of trivia comments

3 views
Skip to first unread message

Markus Gattol

unread,
May 27, 2011, 9:37:25 PM5/27/11
to Colony Users
One thing I noticed right away with Colony's codebase is that it has a
lot of comments which are completely unnecessary and actually more of
a distraction rather than helpful http://goo.gl/OM9GQ


Example:
... /colony/colony/base/plugin_system.py
class Event
def is_event_or_sub_event(self, event)
...
# returns true <--- really? (that's
just one example)
...

I'd fire something like this sed -i 's?# returns true??g' * at the
codebase to rid of all that trivia cruft. We're all smart enough to
read/understand the codebase so let's nuke those kinds of comments :)
Message has been deleted

João Magalhães

unread,
May 27, 2011, 11:01:06 PM5/27/11
to colony...@googlegroups.com
That's a long story and more a hive story than a colony one.
When you try to establish order and organization in your codebase it is sometimes difficult to control and set a border between what's is necessary what's not.
The fact is that I can't get you a good reason for that kind of comments to exist but I can't remove them in an easy manner (without compromising the beauty of the code).
Probably 90 % (or more) of the framework code is self-explainatory (just with code), but still it is commented for aesthetic purposes. Maybe the best solution is to remove the comments during build automation.
For us is not a real problem, but I understand your point of view as it's not common or usefull :)

Markus Gattol

unread,
May 28, 2011, 11:52:17 AM5/28/11
to Colony Users
No problem here either but stuff like #return true followed by a line
of return True has nothing to do with having a sane coding style/
convention that everybody in the community/team adheres to (which I am
+1 on), it's just superfluous :-)
Reply all
Reply to author
Forward
0 new messages