| Home | Trees | Index | Help |
|
|---|
| Package epydoc :: Package markup :: Module plaintext |
|
Parser for plaintext docstrings. Plaintext docstrings are rendered as verbatim output, preserving all whitespace.
| Classes | |
|---|---|
ParsedPlaintextDocstring |
|
| Function Summary | |
|---|---|
@return: A pair C{(M{d}, M{e})}, where C{M{d}} is a C{ParsedDocstring} that encodes the contents of the given plaintext docstring; and C{M{e}} is a list of errors that were generated while parsing the docstring. | |
| Function Details |
|---|
parse_docstring(docstring, errors, **options)
@return: A pair C{(M{d}, M{e})}, where C{M{d}} is a
C{ParsedDocstring} that encodes the contents of the given
plaintext docstring; and C{M{e}} is a list of errors that were
generated while parsing the docstring.
@rtype: C{L{ParsedPlaintextDocstring}, C{list} of L{ParseError}}
|
| Home | Trees | Index | Help |
|
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:19 2004 | http://epydoc.sf.net |