Style guide and docstring conventions for Ganga source code
The docstring should follow the pydoc convention: the first non-blank line is a short description. It should be followed by a blank line. And then comes the long description. For example:
class SomeGPIClass:
"""
short description (just one line). this may be a single line in the docstring.
long1.
long2.
long3....
"""
The following PEPs outline the recommended style guide and docstring conventions for Ganga source code:
PEP 8 -- Style Guide for Python Code:
http://www.python.org/dev/peps/pep-0008/
PEP 257 -- Docstring Conventions:
http://www.python.org/dev/peps/pep-0257/
-- Main.dtuckett - 27 Jun 2007