Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UtilitiesPython2.CodeStyleChecker.html
Documentation/Source/eric5.UtilitiesPython2.CodeStyleChecker.html
- changeset 2985
- 177b1858245f
equal
deleted
inserted
replaced
| 2984:031cceaa8b01 | 2985:177b1858245f |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric5.UtilitiesPython2.CodeStyleChecker</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric5.UtilitiesPython2.CodeStyleChecker</h1> | |
| 23 <p> | |
| 24 Class implementing the PEP 8 checker for Python2. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#CodeStyleReport">CodeStyleReport</a></td> | |
| 34 <td>Class implementing a special report to be used with our dialog.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="CodeStyleReport" ID="CodeStyleReport"></a> | |
| 43 <h2>CodeStyleReport</h2> | |
| 44 <p> | |
| 45 Class implementing a special report to be used with our dialog. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 pep8.BaseReport | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <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> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#CodeStyleReport.__init__">CodeStyleReport</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#CodeStyleReport.error_args">error_args</a></td> | |
| 64 <td>Public method to collect the error messages.</td> | |
| 65 </tr> | |
| 66 </table> | |
| 67 <h3>Static Methods</h3> | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <a NAME="CodeStyleReport.__init__" ID="CodeStyleReport.__init__"></a> | |
| 72 <h4>CodeStyleReport (Constructor)</h4> | |
| 73 <b>CodeStyleReport</b>(<i>options</i>) | |
| 74 <p> | |
| 75 Constructor | |
| 76 </p><dl> | |
| 77 <dt><i>options</i></dt> | |
| 78 <dd> | |
| 79 options for the report (optparse.Values) | |
| 80 </dd> | |
| 81 </dl><a NAME="CodeStyleReport.error_args" ID="CodeStyleReport.error_args"></a> | |
| 82 <h4>CodeStyleReport.error_args</h4> | |
| 83 <b>error_args</b>(<i>line_number, offset, code, check, *args</i>) | |
| 84 <p> | |
| 85 Public method to collect the error messages. | |
| 86 </p><dl> | |
| 87 <dt><i>line_number</i></dt> | |
| 88 <dd> | |
| 89 line number of the issue (integer) | |
| 90 </dd><dt><i>offset</i></dt> | |
| 91 <dd> | |
| 92 position within line of the issue (integer) | |
| 93 </dd><dt><i>code</i></dt> | |
| 94 <dd> | |
| 95 message code (string) | |
| 96 </dd><dt><i>check</i></dt> | |
| 97 <dd> | |
| 98 reference to the checker function (function) | |
| 99 </dd><dt><i>args</i></dt> | |
| 100 <dd> | |
| 101 arguments for the message (list) | |
| 102 </dd> | |
| 103 </dl><dl> | |
| 104 <dt>Returns:</dt> | |
| 105 <dd> | |
| 106 error code (string) | |
| 107 </dd> | |
| 108 </dl> | |
| 109 <div align="right"><a href="#top">Up</a></div> | |
| 110 <hr /> | |
| 111 </body></html> |
