Changes between Version 17 and Version 18 of DeveloperGuidelines/CodeConventions

Timestamp:

03/20/11 20:58:52 (14 years ago)

Author:

Fran Boon

Comment:

--

DeveloperGuidelines/CodeConventions

@@ -11 +11 @@
   * Limit line length to 80 characters
  * Use " " for strings, UNLESS the string contains a ", in which case use '
- * All functions should include Docstrings like:
-{{{
-"""
-    This function is just an example
-    @param: None
-"""
-}}}
+
 === PEP8 Script ===
 Use static/scripts/tools/pep8.py to check for PEP8 compliance.
@@ -34 +28 @@
 
  * All files, classes and functions should have docstrings which allow to auto-generate API documentation using [http://epydoc.sourceforge.net epydoc]
+Suggested style:
+{{{
+"""
+    This function is just an example
+    @param: None
+"""
+}}}
 
 == Internationalisation ==