Pydoc seem to ignore my comment

Thomas Weholt 2002 at weholt.org
Wed Nov 6 17:31:31 EST 2002


If I do something like :

class Test:
    """
    Lots of docs.
    """
    def __init__(self):
        """
        Docs here too
        """

    def go(self):
        """
        More docs.
        """

The doc-string just below the class-definition is included, all other
doc-strings are ignored in the generated documentation. Why ????

How must a declare my doc-string for them to be included??

PS! Will pydoc ever support more elaborate things ( arguments description
etc. ) like JavaDoc and Effbots take on documentation generation?

Best regards,
Thomas






More information about the Python-list mailing list