Add paragraph on code style

This commit is contained in:
Stein Magnus Jodal 2010-02-14 01:01:45 +01:00
parent f59a0a042d
commit 85a34d943b

View File

@ -24,10 +24,25 @@ modular, so we can extend it with other backends in the future, like file
playback and other online music services such as Last.fm. playback and other online music services such as Last.fm.
Code style
==========
We generally follow the `PEP-8 <http://www.python.org/dev/peps/pep-0008/>`_
style guidelines, with a couple of notable exceptions:
- We only indent continuation lines with an addition four spaces relative to
the previous line.
- An exception to the previous exception: When continuing control flow
statements like ``if``, ``for`` and ``while``, indent the continuation lines
with eight spaces, so that it is indented an additional level compared to the
following block of code.
Running tests Running tests
============= =============
To run tests, you need a couple of dependiencies. Some can be installed through Debian/Ubuntu package management:: To run tests, you need a couple of dependencies. Some can be installed through
Debian/Ubuntu package management::
sudo aptitude install python-coverage sudo aptitude install python-coverage