Developer Guidelines

Jump to bottom Edit New page

Hannes Bretschneider edited this page Sep 26, 2010 · 9 revisions

Variable names

Use explicit variable names:

yes: num_observations

no: N
Use "components" instead of "clusters".

Docstrings

See http://github.com/numpy/numpy/blob/master/doc/example.py for rules.

Testing

Only code that passes all tests is allowed in the master branch.
A test case must be written to reproduce any bug, before the bugs is corrected.

Coding Style

Code should pass pep8 and pyflakes