<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.markup.plaintext</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
Module plaintext
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.markup.plaintext-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module plaintext</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html">source code</a></span></p>
<p>Parser for plaintext docstrings. Plaintext docstrings are rendered as
verbatim output, preserving all whitespace.</p>
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html" class="summary-name">ParsedPlaintextDocstring</a>
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code><a
href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html"
class="link">ParsedPlaintextDocstring</a>, <code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a></code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.markup.plaintext-module.html#parse_docstring" class="summary-sig-name">parse_docstring</a>(<span class="summary-sig-arg">docstring</span>,
<span class="summary-sig-arg">errors</span>,
<span class="summary-sig-arg">**options</span>)</span><br />
Returns:
A pair <code>(<i class="math">d</i>, <i class="math">e</i>)</code>,
where <code><i class="math">d</i></code> is a
<code>ParsedDocstring</code> that encodes the contents of the given
plaintext docstring; and <code><i class="math">e</i></code> is a list
of errors that were generated while parsing the docstring.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#parse_docstring">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_docstring_4-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_docstring_4-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_docstring_4" name="call_graph_for_parse_docstring_4">
<area shape="rect" href="epydoc.markup-module.html#parse" title="parse()" alt="" coords="6,6,80,38" />
<area shape="rect" href="epydoc.markup.plaintext-module.html#parse_docstring" title="parse_docstring()" alt="" coords="130,6,282,38" />
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__" title="ParsedPlaintextDocstring.__init__()" alt="" coords="332,6,620,38" />
</map>
<img src="call_graph_for_parse_docstring_4.gif" alt='' usemap="#call_graph_for_parse_docstring_4" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="parse_docstring"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_docstring</span>(<span class="sig-arg">docstring</span>,
<span class="sig-arg">errors</span>,
<span class="sig-arg">**options</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.markup.plaintext-pysrc.html#parse_docstring">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_docstring_4-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_docstring_4-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_docstring_4" name="call_graph_for_parse_docstring_4">
<area shape="rect" href="epydoc.markup-module.html#parse" title="parse()" alt="" coords="6,6,80,38" />
<area shape="rect" href="epydoc.markup.plaintext-module.html#parse_docstring" title="parse_docstring()" alt="" coords="130,6,282,38" />
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__" title="ParsedPlaintextDocstring.__init__()" alt="" coords="332,6,620,38" />
</map>
<img src="call_graph_for_parse_docstring_4.gif" alt='' usemap="#call_graph_for_parse_docstring_4" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<dl class="fields">
<dt>Returns: <code><a
href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html"
class="link">ParsedPlaintextDocstring</a>, <code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link">ParseError</a></code></dt>
<dd>A pair <code>(<i class="math">d</i>, <i
class="math">e</i>)</code>, where <code><i
class="math">d</i></code> is a <code>ParsedDocstring</code> that
encodes the contents of the given plaintext docstring; and
<code><i class="math">e</i></code> is a list of errors that were
generated while parsing the docstring.</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:06:45 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
