Contributing

Style guide

Follow the recommendations from PEP 8 – Style Guide for Python Code.

Docstring

Docstrings should use the reStructuredText (reST) format. For details see, e.g., this stackoverflow question, the Sphinx + ReadTheDocs documentation or the example below.

Example:

This is a reStructuredText style.
"""
:param param1: first param
:type param1: type of first param
:return: description of what is returned
:rtype: type of return value
:raises keyError: raises an exception
"""