Differences between revisions 3 and 4
Revision 3 as of 2008-02-07 15:36:54
Size: 1009
Editor: abuehl
Comment: cat
Revision 4 as of 2008-03-03 12:52:39
Size: 1054
Editor: mpm
Comment:
Deletions are marked like this. Additions are marked like this.
Line 6: Line 6:
 * don't name functions with CamelCase
* don't name functions with lots_of_under_bars
 * don't name functions or classes with Uppercase, CamelCase or lots_of_under_bars
Line 9: Line 8:
 * don't name your classes in Uppercase
Line 12: Line 10:
 * 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 use a class unless it makes your code smaller and easier to read
 * don't use set(), sorted(), rsplit(), or various other post-Py2.3 goodies
 * don't use Unicode strings unless you ''really'' grok Mercurial's charset philosophy

Don'ts:

  • don't use tabs
  • don't use lines longer than 80 characters
  • don't leave trailing whitespace
  • don't name functions or classes with Uppercase, CamelCase or lots_of_under_bars

  • don't make helper functions prefixed with do_
  • 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 unless it makes your code smaller and easier to read
  • don't use set(), sorted(), rsplit(), or various other post-Py2.3 goodies
  • don't use Unicode strings unless you really grok Mercurial's charset philosophy

  • 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)