Coding Convention

The coding convention is pretty much that described in pep-0008

import module.not.ShortName as ShortName

def module_function():
    print "I am a function"

class ClassName(ParentClass)
    """
    I am a comment
    """

    CONSTANT_VALUE = 7

    def __init__(self):
        ParentClass.__init__(self)
        #Small comment
        self.variableName = 42
        self.bar = None

        self.setup_function_call()

    def _private_functions_go_first(self, *args):
        pass

    @classmethod
    def class_or_static_methods(self, baz):
        pass

    def public_function(self, foo):
        if foo == 42:
            self.long_named_function_call(
                        parameter1,
                        parameter2)
        elif foo == False:
            self.variableName = ClassName.CONSTANT_VALUE
        else:
            raise Exception("Bah!")

Changelog

Commits should include a ChangeLog describing the change. I recommend generating this with [prepate-ChangeLog.pl] or any tool which outputs ChangeLogs in the following format.

2008-02-12  John Stowers  <john.stowers@gmail.com>

	* conduit/Settings.py:
	* conduit/gtkui/UI.py: Make the rgba colormap a gconf option until I can
	work out why it corrupts screen rendering on my system
	
	* conduit/modules/FileModule/FileConfiguration.py: Finally save and restore
	the selected folder correctly. Fixes bug #510523