Version 3 by Peter May
on Oct 26, 2012 14:08.

compared with
Current by Peter May
on Oct 26, 2012 14:16.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (1)

View Page History
This page defines guidelines and best practice when developing Python components for the SCAPE project. It has been defined as part of the initial functional review (MS17), however these guidelines are open for discussion, amendment and adaptation as appropriate.

h1. Python

The following section provides guidelines for developing software using Python.

h2. Coding Standards

The [PEP8 - Style Guide for Python Code|http://www.python.org/dev/peps/pep-0008/] SHOULD be used.

h2. Comments

Please use them.

h2. DocStrings

As highlighted in [PEP8|http://www.python.org/dev/peps/pep-0008/], docstrings MUST be written for all public modules, functions, classes, and methods. Docstrings are not necessary for non-public methods, but you should have a comment that describes what the method does. 

[PEP257 - DocString Conventions|http://www.python.org/dev/peps/pep-0257/] SHOULD be used for writing good docstrings.

h2. Unit Tests