Interface descriptions for Python

Asked Apr 22 '14 at 09:37

Active Apr 23 '14 at 14:15

Viewed 74 times

I have some interfaces in my Python code. I have to somehow write, what types their input parameters have and what types do the methods return.

Just now it is dome like this:

def megaMethod(mega_param):
    """
    A cool method! ^__^
    mega_param: ndarray
    returns: ndarray
    """
    assert False

What is the conventional way of such auto-documenting?

edited Apr 23 '14 at 14:15

asked Apr 22 '14 at 09:37

Felix

The [doxygen] tag is confusing me. If you're using doxygen, you should read the documentation for parameters. If you're not using doxygen, you should remove the tag. – Darrick Herwehe Apr 23 '14 at 12:32
Duplicate of http://stackoverflow.com/questions/5334531/python-documentation-standard-for-docstring – unode Apr 23 '14 at 13:04

0 Answers0