Mercurial Repositories > eric / annotate

src/eric7/Documentation/Source/index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.html@e8932a99beb4 (annotated)

src/eric7/Documentation/Source/index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.html

Sat, 14 Dec 2024 13:03:11 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 14 Dec 2024 13:03:11 +0100
branch
eric7
changeset 11093
e8932a99beb4
parent 10479
856476537696
child 11143
ef75c265ab47
permissions
-rw-r--r--

pip Interface
- Changed the package search function to open an external web browser with the package search term (PyPI does not support programmatic search anymore).

8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker</title>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
8596
d64760b2da50 Documentation Generator: streamlined the code to use an external style sheet file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8372
diff changeset
5 <link rel="stylesheet" href="styles.css">
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker</h1>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 <p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 Package containing the code style checker and fixer plug-in.
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 </p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10368
diff changeset
13
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 <h3>Packages</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.html">Annotations</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 <td>Package implementing the function type annotations checker.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <tr>
10116
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
22 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Async.html">Async</a></td>
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
23 <td>Package implementing a checker for "async" related issues.</td>
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
24 </tr>
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
25 <tr>
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.html">Complexity</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <td>Package implementing the code complexity checker.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.html">DocStyle</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <td>Package implementing the code documentation checker.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <tr>
8877
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
34 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.html">Imports</a></td>
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
35 <td>Package implementing a checker for import statements.</td>
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
36 </tr>
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
37 <tr>
10368
8765229e7cc8 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10116
diff changeset
38 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.html">Logging</a></td>
8765229e7cc8 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10116
diff changeset
39 <td>Package implementing the logging style checker.</td>
8765229e7cc8 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10116
diff changeset
40 </tr>
8765229e7cc8 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10116
diff changeset
41 <tr>
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.html">Miscellaneous</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <td>Package implementing the checker for miscellaneous issues.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <tr>
10046
35b27af462ef Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
46 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.html">NameOrder</a></td>
35b27af462ef Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
47 <td>Package implementing a checker for the name order of import statements and handled exceptions.</td>
35b27af462ef Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
48 </tr>
35b27af462ef Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
49 <tr>
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.html">Naming</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <td>Package implementing the naming style checker.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.PathLib.html">PathLib</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <td>Package implementing the checker for functions that can be replaced by use of the pathlib module.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.html">Security</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <td>Package implementing the security checker.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Simplify.html">Simplify</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td>Package implementing a checker to help simplifying the code.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 </tr>
10054
d7a47f0cff2b Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10046
diff changeset
65 <tr>
d7a47f0cff2b Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10046
diff changeset
66 <td><a href="index-eric7.Plugins.CheckerPlugins.CodeStyleChecker.Unused.html">Unused</a></td>
d7a47f0cff2b Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10046
diff changeset
67 <td>Package implementing a checker for unused arguments, variables, ...</td>
d7a47f0cff2b Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10046
diff changeset
68 </tr>
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <h3>Modules</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html">AstUtilities</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td>Module implementing some utility and compatibility functions for working with the ast module.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog.html">CodeStyleAddBuiltinIgnoreDialog</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <td>Module implementing a dialog to enter the data for a built-in assignment to be ignored.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html">CodeStyleChecker</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <td>Module implementing the code style checker.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html">CodeStyleCheckerDialog</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <td>Module implementing a dialog to show the results of the code style check.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <tr>
8877
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
91 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerUtilities.html">CodeStyleCheckerUtilities</a></td>
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
92 <td>Module implementing utility functions for the code style checker dialogs.</td>
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
93 </tr>
548d45c3f571 Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8596
diff changeset
94 <tr>
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog.html">CodeStyleCodeSelectionDialog</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <td>Module implementing a dialog to select code style message codes.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html">CodeStyleFixer</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <td>Module implementing a class to fix certain code style issues.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog.html">CodeStyleStatisticsDialog</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <td>Module implementing a dialog showing statistical data for the last code style checker run.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <tr>
10116
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
107 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.ast_unparse.html">ast_unparse</a></td>
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
108 <td></td>
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
109 </tr>
4a619fb7bd09 Code Style Checker
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10054
diff changeset
110 <tr>
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html">pycodestyle</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <td></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <td><a href="eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations.html">translations</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <td>Module implementing message translations for the code style plugin messages.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10368
diff changeset
119 </body></html>

Mercurial Repository: eric

eric ide

mercurial