epydoc.markup.plaintext.ParsedPlaintextDocstring

Package epydoc :: Package markup :: Module plaintext :: Class ParsedPlaintextDocstring |
[show private | hide private]
[frames | no frames]

## Class ParsedPlaintextDocstring

    ParsedDocstring --+
                      |
                     ParsedPlaintextDocstring

Method Summary
| `__init__(self, text, **options)`
| ``concatenate`(self, other)` Return a new parsed docstring containing the concatination of this docstring and `other`.
`ParsedDocstring` | ``summary`(self)` Return a short summary of this docstring.
`string` | ``to_html`(self, docstring_linker, **options)` Translate this docstring to HTML.
`string` | ``to_latex`(self, docstring_linker, **options)` Translate this docstring to LaTeX.
`string` | ``to_plaintext`(self, docstring_linker, **options)` Translate this docstring to plaintext.
Inherited from `ParsedDocstring`: `__add__`, `index_terms`, `split_fields`

Method Details

### concatenate(self, other) Returns: A new parsed docstring containing the concatination of this docstring and `other`. Raises: `ValueError` - If the two parsed docstrings are incompatible. Overrides: `epydoc.markup.ParsedDocstring.concatenate` (inherited documentation)

### summary(self) Returns: A short summary of this docstring. Typically, the summary consists of the first sentence of the docstring. (type=`ParsedDocstring`) Overrides: `epydoc.markup.ParsedDocstring.summary` (inherited documentation)

### to_html(self, docstring_linker, **options) Translate this docstring to HTML. Parameters: `docstring_linker` - An HTML translator for crossreference links into and out of the docstring. (type=`DocstringLinker`) `options` - Any extra options for the output. Unknown options are ignored. Returns: An HTML fragment that encodes this docstring. (type=`string`) Overrides: `epydoc.markup.ParsedDocstring.to_html` (inherited documentation)

### to_latex(self, docstring_linker, **options) Translate this docstring to LaTeX. Parameters: `docstring_linker` - A LaTeX translator for crossreference links into and out of the docstring. (type=`DocstringLinker`) `options` - Any extra options for the output. Unknown options are ignored. Returns: A LaTeX fragment that encodes this docstring. (type=`string`) Overrides: `epydoc.markup.ParsedDocstring.to_latex` (inherited documentation)

### to_plaintext(self, docstring_linker, **options) Translate this docstring to plaintext. Parameters: `docstring_linker` - A plaintext translator for crossreference links into and out of the docstring. (type=`DocstringLinker`) `options` - Any extra options for the output. Unknown options are ignored. Returns: A plaintext fragment that encodes this docstring. (type=`string`) Overrides: `epydoc.markup.ParsedDocstring.to_plaintext` (inherited documentation)

Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004 | http://epydoc.sf.net