[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/02/04 12:20:33

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

Log message:
        Updated based on discussion few weeks ago.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/gzz/doc/pegboard/coding_standard--vegai/peg.rst.diff?tr1=1.10&tr2=1.11&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.10 
gzz/doc/pegboard/coding_standard--vegai/peg.rst:1.11
--- gzz/doc/pegboard/coding_standard--vegai/peg.rst:1.10        Mon Jan 13 
07:18:35 2003
+++ gzz/doc/pegboard/coding_standard--vegai/peg.rst     Tue Feb  4 12:20:32 2003
@@ -3,8 +3,8 @@
 =============================================================
 
 :Author:   Vesa Kaihlavirta
-:Last-Modified: $Date: 2003/01/13 12:18:35 $
-:Revision: $Revision: 1.10 $
+:Last-Modified: $Date: 2003/02/04 17:20:32 $
+:Revision: $Revision: 1.11 $
 :Status:   Current
 :Scope:           Minor
 :Type:     Policy
@@ -37,7 +37,10 @@
 
 - should Tabs be allowed or not?
 
-    Perhaps a conversion tool at "make committable"?
+    RESOLVED: a conversion tool at "make committable" will
+    convert tabs into 8 spaces
+
+- import grouping is not resolved
 
 Changes
 =======
@@ -50,7 +53,7 @@
 2. Header comments should include authors.
 
 3. After header comments, rcsid:
-   rcsid = "$Id: peg.rst,v 1.10 2003/01/13 12:18:35 Vegai Exp $"
+   rcsid = "$Id: peg.rst,v 1.11 2003/02/04 17:20:32 Vegai Exp $"
 
 4. After rcsid, the imports (unless there's a good reason to delay
    importing).
@@ -75,22 +78,22 @@
    - java imports
    - gzz imports
 
+   * imports should be in alphabetical order in the groups
+   
 6. Code should be structured so that it can be imported and re-used, for 
example by
    putting state in classes instead of the module namespace. Executable code
    in module namespace is discouraged -- except for "if __name__=='__main__':"
 
-7. Prefer list comprehensions to iterations, especially when dealing with 
lists.
-
-8. Class names are CapitalizedWords.
+7. Class names are CapitalizedWords.
 
-9. Class methods and attributes are mixedCase.
+8. Class methods and attributes are mixedCase.
 
-10. Functions are lower_case_with_underscores, variables are lowercase.
+9. Functions and variables are mixedCase.
 
-11. Tab-size is 8 (will be converted to spaces by make committable), 
indentation
+9. Tab-size is 8 (will be converted to spaces by make committable), indentation
     at 4 spaces.
 
-12. Never use tabs.
+10. Never use tabs.
 
 
 Notes
@@ -98,7 +101,7 @@
 
 - items 8-12 are arbitrary choices for the sake of consistency
 
-- "A Foolish Consistency is the Hobgoblin of Little Minds" - Guido van Rossum
+- "A Foolish Consistency is the Hobgoblin of Little Minds" - Ralph Waldo 
Emerson
 
 
 References