Changes between Version 3 and Version 4 of CodingStandard


Ignore:
Timestamp:
09/08/06 16:00:38 (13 years ago)
Author:
lawrence
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CodingStandard

    v3 v4  
    1 ==== Python Coding Standards for NDG ==== 
     1=== Python Coding Standards for NDG === 
    22 
    3 In all scripts we should make the best use of module level doc strings. 
     3 * See the [wiki:ndg.utils] page for links to best practice in logging, error handling, config file 
     4usage, xml and date handling. 
     5 * See also [wiki:UnitTestsBestPractice], [wiki:ndgLookNFeel]  
     6 
     7==== Documentation Standards ==== 
     8 
     9In all scripts we should make the best use of module level doc strings as well as method and  
     10class strings. 
    411 
    512e.g. for module.py 
     
    815 '''some stuff about module ''' 
    916  def exitNicely(msg): 
     17     ''' here is a method string: this method produce a nice informative exit message ... 
    1018     print __doc__ 
    1119     print msg 
    1220     sys.exit() 
    1321}}} 
     22 
     23==== General Coding Level Standards ==== 
    1424 
    1525 * All classes should start with a capital 
     
    2232 * we will use epydoc 
    2333 
     34==== Python Guidance ==== 
    2435 
    2536Usefile ideas: 
     
    5061will make y 5 if x>10 ... 
    5162 
    52