Changes between Version 17 and Version 18 of DeveloperGuidelines/CodeConventions


Ignore:
Timestamp:
03/20/11 20:58:52 (11 years ago)
Author:
Fran Boon
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/CodeConventions

    v17 v18  
    1111  * Limit line length to 80 characters
    1212 * Use " " for strings, UNLESS the string contains a ", in which case use '
    13  * All functions should include Docstrings like:
    14 {{{
    15 """
    16     This function is just an example
    17     @param: None
    18 """
    19 }}}
     13
    2014=== PEP8 Script ===
    2115Use static/scripts/tools/pep8.py to check for PEP8 compliance.
     
    3428
    3529 * All files, classes and functions should have docstrings which allow to auto-generate API documentation using [http://epydoc.sourceforge.net epydoc]
     30Suggested style:
     31{{{
     32"""
     33    This function is just an example
     34    @param: None
     35"""
     36}}}
    3637
    3738== Internationalisation ==