Documentation & docstrings

Every module must start with the following docstring:

# -*- coding: utf-8 -*-
"""
Python Flight Mechanics Engine (PyFME).
Copyright (c) AeroPython Development Team. 
Distributed under the terms of the MIT License.

<Module name>
-------------
<Brief description ...>
< ... >

"""

template.py file in Spyder's configuration folder can be modified in order to provide with this template automatically when opening a new module file.

Docstrings for documentation of functions and classes must follow NumPy style: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

• "Short summary", "Parameters" and "Returns" sections are mandatory. So it is the section "References" if applicable.
• "Notes" and "Examples" sections are recommended.