--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.UtilitiesPython2.CodeStyleChecker.html Fri Oct 04 17:48:17 2013 +0200 @@ -0,0 +1,111 @@ +<!DOCTYPE html> +<html><head> +<title>eric5.UtilitiesPython2.CodeStyleChecker</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.CodeStyleChecker</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="#CodeStyleReport">CodeStyleReport</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="CodeStyleReport" ID="CodeStyleReport"></a> +<h2>CodeStyleReport</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="#CodeStyleReport.__init__">CodeStyleReport</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#CodeStyleReport.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="CodeStyleReport.__init__" ID="CodeStyleReport.__init__"></a> +<h4>CodeStyleReport (Constructor)</h4> +<b>CodeStyleReport</b>(<i>options</i>) +<p> + Constructor +</p><dl> +<dt><i>options</i></dt> +<dd> +options for the report (optparse.Values) +</dd> +</dl><a NAME="CodeStyleReport.error_args" ID="CodeStyleReport.error_args"></a> +<h4>CodeStyleReport.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><dl> +<dt>Returns:</dt> +<dd> +error code (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file