<?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.epytext.StructuringError</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> :: <a href="epydoc.markup.epytext-module.html">Module epytext</a> :: Class StructuringError </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.epytext.StructuringError-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class StructuringError</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup.epytext-pysrc.html#StructuringError">source code</a></span></p> <center> <center> <map id="uml_class_diagram_for_epydoc_m_11" name="uml_class_diagram_for_epydoc_m_11"> <area shape="rect" href="epydoc.markup.ParseError-class.html#__init__" title="epydoc.markup.ParseError.__init__" alt="" coords="17,111,300,129" /> <area shape="rect" href="epydoc.markup.ParseError-class.html#is_fatal" title="Returns: true if this is a fatal error." alt="" coords="17,129,300,148" /> <area shape="rect" href="epydoc.markup.ParseError-class.html#linenum" title="Returns: The line number on which the error occured (including any offset)." alt="" coords="17,148,300,167" /> <area shape="rect" href="epydoc.markup.ParseError-class.html#set_linenum_offset" title="Set the line number offset for this error." alt="" coords="17,167,300,185" /> <area shape="rect" href="epydoc.markup.ParseError-class.html#descr" title="epydoc.markup.ParseError.descr" alt="" coords="17,185,300,204" /> <area shape="rect" href="epydoc.markup.ParseError-class.html#__str__" title="Return a string representation of this ParseError." alt="" coords="17,204,300,223" /> <area shape="rect" href="epydoc.markup.ParseError-class.html#__repr__" title="Return the formal representation of this ParseError." alt="" coords="17,223,300,241" /> <area shape="rect" href="epydoc.markup.ParseError-class.html#__cmp__" title="Compare two ParseErrors, based on their line number." alt="" coords="17,241,300,260" /> <area shape="rect" href="epydoc.markup.ParseError-class.html" title="The base class for errors generated while parsing docstrings." alt="" coords="5,80,312,267" /> <area shape="rect" href="epydoc.markup.epytext.StructuringError-class.html" title="An error generated while structuring a formatted documentation string." alt="" coords="99,285,219,328" /> <area shape="rect" href="javascript:void(0);" title="exceptions.Exception.__getitem__" alt="" coords="95,36,223,55" /> <area shape="rect" href="javascript:void(0);" title="Common base class for all exceptions." alt="" coords="83,5,235,61" /> </map> <img src="uml_class_diagram_for_epydoc_m_11.gif" alt='' usemap="#uml_class_diagram_for_epydoc_m_11" ismap="ismap" class="graph-without-title" /> </center> </center> <hr /> <p>An error generated while structuring a formatted documentation string.</p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></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">Instance Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceMethods" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.markup.ParseError-class.html">ParseError</a></code></b>: <code><a href="epydoc.markup.ParseError-class.html#__cmp__">__cmp__</a></code>, <code><a href="epydoc.markup.ParseError-class.html#__init__">__init__</a></code>, <code><a href="epydoc.markup.ParseError-class.html#__repr__">__repr__</a></code>, <code><a href="epydoc.markup.ParseError-class.html#__str__">__str__</a></code>, <code><a href="epydoc.markup.ParseError-class.html#descr">descr</a></code>, <code><a href="epydoc.markup.ParseError-class.html#is_fatal">is_fatal</a></code>, <code><a href="epydoc.markup.ParseError-class.html#linenum">linenum</a></code>, <code><a href="epydoc.markup.ParseError-class.html#set_linenum_offset">set_linenum_offset</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.Exception</code></b>: <code>__getitem__</code> </p> </td> </tr> </table> <!-- ==================== INSTANCE VARIABLES ==================== --> <a name="section-InstanceVariables"></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">Instance Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceVariables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.markup.ParseError-class.html">ParseError</a></code></b> (private): <code><a href="epydoc.markup.ParseError-class.html#_descr" onclick="show_private();">_descr</a></code>, <code><a href="epydoc.markup.ParseError-class.html#_fatal" onclick="show_private();">_fatal</a></code>, <code><a href="epydoc.markup.ParseError-class.html#_linenum" onclick="show_private();">_linenum</a></code>, <code><a href="epydoc.markup.ParseError-class.html#_offset" onclick="show_private();">_offset</a></code> </p></div> </td> </tr> </table> <!-- ==================== 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:08:36 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>