Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html

Mon, 23 Sep 2013 19:32:25 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 23 Sep 2013 19:32:25 +0200
changeset 2929
28ab0bc63d69
parent 2867
eb325d7f7335
child 2966
f85f686981ad
permissions
-rw-r--r--

Finished enhancing the docstring checker to include the eric docstring style.

<!DOCTYPE html>
<html><head>
<title>eric5.UtilitiesPython2.Pep8Checker</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.UtilitiesPython2.Pep8Checker</h1>
<p>
Class implementing the PEP 8 checker for Python2.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#Pep8Report">Pep8Report</a></td>
<td>Class implementing a special report to be used with our dialog.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="Pep8Report" ID="Pep8Report"></a>
<h2>Pep8Report</h2>
<p>
    Class implementing a special report to be used with our dialog.
</p>
<h3>Derived from</h3>
pep8.BaseReport
<h3>Class Attributes</h3>
<table>
<tr><td>docType</td></tr><tr><td>filename</td></tr><tr><td>hang_closing</td></tr><tr><td>ignore</td></tr><tr><td>max_line_length</td></tr><tr><td>repeat</td></tr><tr><td>select</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#Pep8Report.__init__">Pep8Report</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#Pep8Report.error_args">error_args</a></td>
<td>Public method to collect the error messages.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Pep8Report.__init__" ID="Pep8Report.__init__"></a>
<h4>Pep8Report (Constructor)</h4>
<b>Pep8Report</b>(<i>options</i>)
<p>
        Constructor
</p><dl>
<dt><i>options</i></dt>
<dd>
options for the report (optparse.Values)
</dd>
</dl><a NAME="Pep8Report.error_args" ID="Pep8Report.error_args"></a>
<h4>Pep8Report.error_args</h4>
<b>error_args</b>(<i>line_number, offset, code, check, *args</i>)
<p>
        Public method to collect the error messages.
</p><dl>
<dt><i>line_number</i></dt>
<dd>
line number of the issue (integer)
</dd><dt><i>offset</i></dt>
<dd>
position within line of the issue (integer)
</dd><dt><i>code</i></dt>
<dd>
message code (string)
</dd><dt><i>check</i></dt>
<dd>
reference to the checker function (function)
</dd><dt><i>args</i></dt>
<dd>
arguments for the message (list)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial