GitLab

Documenting the python code

form the sphinx.ext.napoleon extension

• Python documentation is generated using sphinx
• Use the Google Python Style Guide

Args:
    path (str): The path of the file to wrap
    field_storage (FileStorage): The :class:`FileStorage` instance to wrap
    temporary (bool): Whether or not to delete the file when the File
       instance is destructed

Returns:
    BufferedFileStorage: A buffered writable file descriptor

• Example of Google style python docstring