Skip to content
Klaus Greff edited this page Sep 28, 2015 · 1 revision

Code formatting

We follow the PEP8 style conventions. They are automatically checked with py.test --pep8 -m pep8 or tox -e pep8.

Documentation

We write docstrings in the google style (example). Additional conventions:

  • Always put argument types in parenthesis
  • Put a leading linebreak after the argument name + type declaration
  • Arguments to the __init__ function go into the class docstring
Clone this wiki locally