eric6/Documentation/Source/index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.html

Sun, 04 Oct 2020 18:53:35 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 04 Oct 2020 18:53:35 +0200
changeset 7756
c23a94f7e2e5
parent 7624
6eabbcf3bdf8
child 7784
3257703e10c5
permissions
-rw-r--r--

Syntax Checker: added a syntax checker for TOML files.

3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Plugins.CheckerPlugins.CodeStyleChecker</title>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
23
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 Package containing the code style checker and fixer plug-in.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27
7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
28 <h3>Packages</h3>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
29 <table>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
30
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
31 <tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
32 <td><a href="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.html">Security</a></td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
33 <td>Package implementing the security checker.</td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
34 </tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7291
diff changeset
35 </table>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Modules</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
39
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <tr>
7246
c32a350d2414 Code Style Checker:
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7040
diff changeset
41 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html">AnnotationsChecker</a></td>
c32a350d2414 Code Style Checker:
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7040
diff changeset
42 <td>Module implementing a checker for function type annotations.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
43 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
44 <tr>
7291
f689a4dcaf62 Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
45 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html">AstUtilities</a></td>
f689a4dcaf62 Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
46 <td>Module implementing some utility and compatibility functions for working with the ast module.</td>
f689a4dcaf62 Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
47 </tr>
f689a4dcaf62 Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
48 <tr>
5623
f4d7cfdadc3f Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5147
diff changeset
49 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog.html">CodeStyleAddBuiltinIgnoreDialog</a></td>
f4d7cfdadc3f Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5147
diff changeset
50 <td>Module implementing a dialog to enter the data for a built-in assignment to be ignored.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
51 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
52 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html">CodeStyleChecker</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <td>Module implementing the code style checker.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
55 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
56 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html">CodeStyleCheckerDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <td>Module implementing a dialog to show the results of the code style check.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
59 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
60 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog.html">CodeStyleCodeSelectionDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <td>Module implementing a dialog to select code style message codes.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
63 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
64 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html">CodeStyleFixer</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td>Module implementing a class to fix certain code style issues.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
67 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
68 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog.html">CodeStyleStatisticsDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <td>Module implementing a dialog showing statistical data for the last code style checker run.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
71 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
72 <tr>
5662
2c99fa1072b6 Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5623
diff changeset
73 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html">ComplexityChecker</a></td>
2c99fa1072b6 Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5623
diff changeset
74 <td>Module implementing a checker for code complexity.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
75 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
76 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html">DocStyleChecker</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <td>Module implementing a checker for documentation string conventions.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
79 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
80 <tr>
4511
b5e4e7efa904 Added a checker for string format strings.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4423
diff changeset
81 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html">MiscellaneousChecker</a></td>
b5e4e7efa904 Added a checker for string format strings.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4423
diff changeset
82 <td>Module implementing a checker for miscellaneous checks.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
83 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
84 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html">NamingStyleChecker</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <td>Module implementing a checker for naming conventions.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
87 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
88 <tr>
7040
f89952e5fc11 Code Style Checker: added check for commented code that should be removed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
89 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.eradicate.html">eradicate</a></td>
f89952e5fc11 Code Style Checker: added check for commented code that should be removed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
90 <td>Removes commented-out Python code.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
91 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
92 <tr>
4423
14f3ca3dcef6 Added a code complexity checker iaw. McCabe to the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
93 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.mccabe.html">mccabe</a></td>
14f3ca3dcef6 Added a code complexity checker iaw. McCabe to the code style checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
94 <td></td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
95 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
96 <tr>
5147
d39dd5cee0c8 Renamed pep8.py to pycodestyle.py in order to track the upstream renaming.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4511
diff changeset
97 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html">pycodestyle</a></td>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <td></td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
99 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7246
diff changeset
100 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 <td><a href="eric6.Plugins.CheckerPlugins.CodeStyleChecker.translations.html">translations</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <td>Module implementing message translations for the code style plugin messages.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 </body></html>

eric ide

mercurial