Pycharm auto function documentation

Pycharm_auto_function_documentation.txt

Pycharm creates a template documentation for new functions.  I did not know what they here.  Found an example at this web site.

https://pypi.python.org/pypi/exdoc

Not sure exactly the content of the page itself but I now know how to specify the documentation in the Pycharm template.


def f(a, b=1, *args):
    ''' Simple function

    : param a: First
    : type a: int
    : param b: Second
    : type b: int
    : param args: More numbers
    : returns: nothing interesting
    : rtype: bool
    : raises ValueError: hopeless condition
    '''