Documents

Technical documentation

Coding Style

2010-10-13 18:28

""" 
Coding style

Classes: MyClass
Methods: my_method
Variables: my_var OR myVar (that does not matter to me)

Line length: 80 characters
Indentation: Lines split up but with same context should
             stick together:

             if (myLongCondition != otherLongThing
...

Plugin API

2010-10-13 18:32

Plugin API

This document describes the methods and properties of the plugin API provides by the "sushi" module.
The module provides a basic class called "Plugin", which can be inherited.
The methods it provides are described below.

Further the "sushi" module provides constants to describe the user configuration interface for the plugin.
...