2006-08-21 10:09:05 +02:00
|
|
|
Maybe we can add some notes here to get a consistent coding experience :)
|
|
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
comments:
|
|
|
|
- should be usable for pydoc
|
2006-08-21 12:10:40 +02:00
|
|
|
- ''' or """ at the beginning of every class/method
|
|
|
|
- ## for longterm comments, that are useful for understanding
|
|
|
|
- #blabla for codelines, that are out for experimenting and might be used later again
|
2006-08-21 10:09:05 +02:00
|
|
|
|
|
|
|
error handling:
|
|
|
|
- unspecific error handling is evil (try: "grep -r except: .")
|
|
|
|
|
|
|
|
unit testing:
|
2006-08-21 12:10:40 +02:00
|
|
|
- write a unittest and then write the relating code until the unittest stops failing :)
|
2006-08-21 10:09:05 +02:00
|
|
|
- commits with broken unit tests are evil (options: fix or disable)
|
|
|
|
|