[Gzz-commits] gzz/doc/pegboard/coding_standard--vegai peg.rst

[Vesa Kaihlavirta]

CVSROOT:        /cvsroot/gzz
Module name:    gzz
Changes by:     Vesa Kaihlavirta <address@hidden>       03/01/09 08:18:55

Modified files:
        doc/pegboard/coding_standard--vegai: peg.rst 

Log message:
        Coding standard proposal, now current.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/gzz/doc/pegboard/coding_standard--vegai/peg.rst.diff?tr1=1.1&tr2=1.2&r1=text&r2=text

Patches:
Index: gzz/doc/pegboard/coding_standard--vegai/peg.rst
diff -u gzz/doc/pegboard/coding_standard--vegai/peg.rst:1.1 
gzz/doc/pegboard/coding_standard--vegai/peg.rst:1.2
--- gzz/doc/pegboard/coding_standard--vegai/peg.rst:1.1 Thu Jan  9 07:53:52 2003
+++ gzz/doc/pegboard/coding_standard--vegai/peg.rst     Thu Jan  9 08:18:55 2003
@@ -3,9 +3,9 @@
 =============================================================
 
 :Author:   Vesa Kaihlavirta
-:Last-Modified: $Date: 2003/01/09 12:53:52 $
-:Revision: $Revision: 1.1 $
-:Status:   Incomplete
+:Last-Modified: $Date: 2003/01/09 13:18:55 $
+:Revision: $Revision: 1.2 $
+:Status:   Current
 :Scope:           Minor
 :Type:     ?
 
@@ -24,18 +24,48 @@
 2) Header comments should include authors.
 
 3) After header comments, rcsid:
-rcsid = "$Id: peg.rst,v 1.1 2003/01/09 12:53:52 Vegai Exp $"
+rcsid = "$Id: peg.rst,v 1.2 2003/01/09 13:18:55 Vegai Exp $"
 
 4) After rcsid, the imports (unless there's a good reason to delay
 importing).
     - Prefer "import foo" to "from foo import bar".
     - Prefer "from foo import bar" to "from foo import *".
+    - No more than one import package in one line, eg.:
+        
+        import os, sys # NO
+        ----
+        import os      # Yes.
+        import sys
 
-INCOMPLETE     
+5) Imports should be grouped in the following order:
+    - standard python imports
+    - 3rd party python imports
+    - java imports
+    - gzz imports
 
+6) All code and data should preferably reside inside a class.
 
-Discussion
-==========
+7) Class names are CapitalizedWords.
 
-Our *.java have the license attached to every file. Is that necessary?  
- 
+8) Class methods are mixedCase.
+
+9) Class attributes are lowercase.
+
+10) Tab-size is 4.
+
+11) Never use tabs.    
+
+
+Questions
+=========
+
+- our *.java have the license attached to every file. Is that necessary?  
+- tests for enforcing parts of the standard?
+
+
+Reference
+=========
+
+http://www.python.org/doc/essays/styleguide.html
+http://www.python.org/peps/pep-0008.html
+http://www.wikipedia.org/wiki/CamelCase