bad documentation

[NKoehring]

The code isn't well documented yet! I think epydoc would be a good choice for this.

[Claudio Corrodi (corrodi-claudio)]

Taht's right. I have no experience with epydoc, but I think it's a good idea and shouldn't be to hard to understand. ;)

[NKoehring (nkoehring)]

Yeah, epydoc is quite simple!

Just look at this exampe:

class foo(object):
    """
    this is the class documentation (in short)

    now we can describe it better with as much lines as we need
    or want for it...

    we can do as much paragraphs as we want!
    """

    def __init__(self, bar, blah):
        """
        they say, the line behind the three doublequotes have to be blank

        I dont know why ^^

        @type bar: some_type
        @param bar: description for "bar"
        @type blah: some_type
        @param blah: blahblahblah
        @rtype: return_type
        @return: something it should return ...I think ^^
        """
        print "Well documented!"