[Dev] epydoc formatting

[Mike Taylor]

By far the biggest thing epydoc complained about was how the paragraphs 
were formatted in a doc string.  The other was how lists are done - 
many times people were using '*' for a list but epydoc prefers '-' and 
it has to be indented correctly.

So I figured I would show some examples that work and some that don't :)

docstrings that work:

    """
    This is the first line

    Paragraph two

    Paragraph three
    """

    """
    First Line

    Paragraph one
      - item one
      - item two
    """

docstrings that don't work:

    """First Line
        Paragraph two
    """

    """
       Paragraph one and this one has to be long
    so that it wraps.
       Paragraph two and this one is also long so
    that it wraps
    """

Of course, the best place to look is on the epydoc help pages 
themselves:  http://epydoc.sourceforge.net/epytext.html
---
Bear

Build and Release Engineer
Open Source Applications Foundation (OSAF)
bear at osafoundation.org
http://www.osafoundation.org

bear at code-bear.com
http://code-bear.com

PGP Fingerprint = 9996 719F 973D B11B E111  D770 9331 E822 40B3 CD29

-------------- next part --------------
A non-text attachment was scrubbed...
Name: PGP.sig
Type: application/pgp-signature
Size: 186 bytes
Desc: This is a digitally signed message part
Url : http://lists.osafoundation.org/pipermail/dev/attachments/20050907/581c7094/PGP.pgp