[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)
[EMAIL PROTECTED]
http://www.osafoundation.org

[EMAIL PROTECTED]
http://code-bear.com

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

PGP.sig
Description: This is a digitally signed message part

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

Open Source Applications Foundation "Dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/dev