Differences between revisions 2 and 3
Revision 2 as of 2007-07-27 15:33:55
Size: 981
Comment: rsplit(), not rstrip(), post-Py2.3
Revision 3 as of 2008-02-07 15:36:54
Size: 1009
Editor: abuehl
Comment: cat
Deletions are marked like this. Additions are marked like this.
Line 28: Line 28:
----
CategoryContributing

Don'ts:

  • don't use tabs
  • don't use lines longer than 80 characters
  • don't leave trailing whitespace
  • don't name functions with CamelCase

  • don't name functions with lots_of_under_bars
  • don't make helper functions prefixed with do_
  • don't name your classes in Uppercase
  • in general, don't make ["mpm"] use his shift key any more than he has to
  • don't use default arguments without a good reason
  • don't use a class to encompass something that's not conceptually an object
  • don't use sorted(), rsplit(), or various other post-Py2.3 goodies
  • don't put OS-specific hacks outside of util.py and friends.

Do:

  • use single quotes rather than double quotes
  • use a single underscore prefix for private methods and functions
  • use a single underscore prefix for a helper function
  • add a linebreak after a colon
  • add docstrings
  • use _() to mark things for i18n
  • add testcases to the test suite
  • run the test suite

-- ["mpm"]


CategoryContributing

CodingStyle (last edited 2022-02-21 17:44:01 by RaphaelGomes)