Mon, 09 Sep 2013 19:26:51 +0200
Regenerated source docu.
2387
2d119e79ab54
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2386
diff
changeset
|
1 | <!DOCTYPE html> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker</title> |
2387
2d119e79ab54
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2386
diff
changeset
|
4 | <meta charset="UTF-8"> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <style> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | body { |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | background: #EDECE6; |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | margin: 0em 1em 10em 1em; |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | color: black; |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | } |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | h1 { color: white; background: #85774A; } |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | h2 { color: white; background: #85774A; } |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | h3 { color: white; background: #9D936E; } |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | h4 { color: white; background: #9D936E; } |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | a { color: #BA6D36; } |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | </style> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | </head> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <body><a NAME="top" ID="top"></a> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <h1>eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker</h1> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <p> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | Module implementing the PEP 8 checker. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | </p> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <h3>Global Attributes</h3> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <table> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <tr><td>None</td></tr> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | </table> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <h3>Classes</h3> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <table> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <tr> |
845
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
33 | <td><a href="#Pep8Py2Checker">Pep8Py2Checker</a></td> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
34 | <td>Class implementing the PEP 8 checker interface for Python 2.</td> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | </tr> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | </table> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <h3>Functions</h3> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <table> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <tr><td>None</td></tr> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | </table> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <hr /><hr /> |
845
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
42 | <a NAME="Pep8Py2Checker" ID="Pep8Py2Checker"></a> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
43 | <h2>Pep8Py2Checker</h2> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
44 | <p> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
45 | Class implementing the PEP 8 checker interface for Python 2. |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
46 | </p> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
47 | <h3>Derived from</h3> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
48 | object |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
49 | <h3>Class Attributes</h3> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
50 | <table> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
51 | <tr><td>None</td></tr> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
52 | </table> |
1228
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
53 | <h3>Class Methods</h3> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
54 | <table> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
55 | <tr><td>None</td></tr> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
56 | </table> |
845
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
57 | <h3>Methods</h3> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
58 | <table> |
1229
a8207dc73672
Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1228
diff
changeset
|
59 | <tr> |
a8207dc73672
Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1228
diff
changeset
|
60 | <td><a href="#Pep8Py2Checker.__init__">Pep8Py2Checker</a></td> |
a8207dc73672
Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1228
diff
changeset
|
61 | <td>Constructor</td> |
a8207dc73672
Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1228
diff
changeset
|
62 | </tr> |
1228
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
63 | </table> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
64 | <h3>Static Methods</h3> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
65 | <table> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
845
diff
changeset
|
66 | <tr><td>None</td></tr> |
845
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
67 | </table> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
68 | <a NAME="Pep8Py2Checker.__init__" ID="Pep8Py2Checker.__init__"></a> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
69 | <h4>Pep8Py2Checker (Constructor)</h4> |
2867
eb325d7f7335
Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2387
diff
changeset
|
70 | <b>Pep8Py2Checker</b>(<i>filename, lines, repeat=False, select="", ignore="", max_line_length=79, hang_closing=False</i>) |
845
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
71 | <p> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
72 | Constructor |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
73 | </p><dl> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
74 | <dt><i>filename</i></dt> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
75 | <dd> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
76 | name of the file to check (string) |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
77 | </dd><dt><i>lines</i></dt> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
78 | <dd> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
79 | source of the file (list of strings) (ignored) |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
80 | </dd><dt><i>repeat=</i></dt> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
81 | <dd> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
82 | flag indicating to repeat message categories (boolean) |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
83 | </dd><dt><i>select=</i></dt> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
84 | <dd> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
85 | list of message IDs to check for |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
86 | (comma separated string) |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
87 | </dd><dt><i>ignore=</i></dt> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
88 | <dd> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
89 | list of message IDs to ignore |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
90 | (comma separated string) |
2867
eb325d7f7335
Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2387
diff
changeset
|
91 | </dd><dt><i>max_line_length=</i></dt> |
eb325d7f7335
Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2387
diff
changeset
|
92 | <dd> |
eb325d7f7335
Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2387
diff
changeset
|
93 | maximum allowed line length (integer) |
eb325d7f7335
Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2387
diff
changeset
|
94 | </dd><dt><i>hang_closing=</i></dt> |
eb325d7f7335
Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2387
diff
changeset
|
95 | <dd> |
2897
45a5370f89a8
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2867
diff
changeset
|
96 | flag indicating to allow hanging closing |
45a5370f89a8
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2867
diff
changeset
|
97 | brackets (boolean) |
845
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
98 | </dd> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
99 | </dl> |
0e937d523b70
Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
832
diff
changeset
|
100 | <div align="right"><a href="#top">Up</a></div> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101 | <hr /> |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102 | </body></html> |