Some handy snippets
Default documentation #
"""short description
extended description
:param arg1: the first value
:type arg1: int, float,...
:returns: arg1/arg2 +arg3
:rtype: int, float
Example::
lala
"""Class file header #
"""This module does ...
"""
import sys
import os
__author__ = "Author"
__email__ = "Email"
__copyright__ = "Copyright"
__license__ = "License"
__version__ = "1.0.1"class doc #
"""brief explanation
extended explanation
:param arg1: description
:param arg2: description
:type arg1: type description
:type arg2: type description
:return: return description
:rtype: the return type description
Example::
obj = Class()
"""Class method documentation #
"""short description
extended description
:param arg1: the first value
:param arg2: the first value
:param arg3: the first value
:type arg1: int, float,...
:type arg2: int, float,...
:type arg3: int, float,...
:returns: arg1/arg2 +arg3
:rtype: int, float
Example::
lala
"""