Python Modules Styleguide

Scorpion Python Modules documentation is based on reStructuredText and Sphinx AutoDoc. Recommended styleguide for python code is Google Python Style Guide.

Recommended file header:

"""
:filename:     <filename>
:author:       <name/email>
:requirements: <module requirements>
:copyright:    <module copyright>
:license:      <module license>


<module description>
::

  1.0.0.2, 23nov2015, <initials>: <changes descrition>
  1.0.0.1, 25mar2012, <initials>: initial
"""

See the example_google for function, class and class methods recommandations.

• example_google module