STYLE

   1 Python code
   2 -----------
   3
   4 - Be compatible with Python 2.3.
   5
   6 - Indent with tabs.
   7
   8 - Continuation lines should be indented using tabs up to the indentation
   9   level and after that using spaces.  This way the code doesn't visually
  10   break with different tab widths.  (If this is too cumbersome, try not to
  11   use continuation lines.)
  12
  13 - Try to keep lines short (ideally under 80 characters measured with 8-space
  14   tabs).  If a longer line benefits readability, that's fine.  (The longer
  15   the line, the better the excuse must be.)
  16
  17 - Import one module per line, and keep imports sorted.  Group system imports
  18   and project imports separately.
  19
  20 - Use new-style classes (inherit from `object`).
  21
  22 - Naming: MyClass, my_function, my_method, my_attribute, _my_protected_member,
  23   __my_private_member.
  24
  25 - Generally follow the style used in the context you're modifying.  If
  26   unsure, follow http://www.python.org/dev/peps/pep-0008/[PEP 8].
  27
  28
  29 Makefiles
  30 ---------
  31
  32 - Be compatible with GNU Make 3.80.
  33
  34
  35 Shell scripts
  36 -------------
  37
  38 - Be POSIX-compliant.
  39
  40
  41 Documentation
  42 -------------
  43
  44 - Use http://www.methods.co.nz/asciidoc/[asciidoc] syntax to make the text
  45   human- and machine-readable.
  46
  47 - Don't go over 80 characters per line.