Updated some source code documentation. eric7

Sat, 22 Feb 2025 18:04:39 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 22 Feb 2025 18:04:39 +0100
branch
eric7
changeset 11144
8c40c5e1ebe0
parent 11143
ef75c265ab47
child 11145
d328a7b74fd8

Updated some source code documentation.

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Async.AsyncChecker.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.NameOrderChecker.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html file | annotate | diff | comparison | revisions
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Async.AsyncChecker.html	Sat Feb 22 18:04:02 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Async.AsyncChecker.html	Sat Feb 22 18:04:39 2025 +0100
@@ -42,6 +42,7 @@
 <h3>Class Attributes</h3>
 <table>
 <tr><td>Codes</td></tr>
+<tr><td>Prefix</td></tr>
 </table>
 
 <h3>Class Methods</h3>
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html	Sat Feb 22 18:04:02 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html	Sat Feb 22 18:04:39 2025 +0100
@@ -74,14 +74,14 @@
 <td>Private method to assemble the list of excluded checks.</td>
 </tr>
 <tr>
+<td><a href="#CodeStyleCheckerDialog.__assembleIncludeMessages">__assembleIncludeMessages</a></td>
+<td>Private method to assemble the list of included checks.</td>
+</tr>
+<tr>
 <td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td>
 <td>Private slot handling the completion of a batch job.</td>
 </tr>
 <tr>
-<td><a href="#CodeStyleCheckerDialog.__cleanupData">__cleanupData</a></td>
-<td>Private method to clean the loaded/entered data of redundant entries.</td>
-</tr>
-<tr>
 <td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td>
 <td>Private method to clear all warning markers of open editors to be checked.</td>
 </tr>
@@ -367,6 +367,25 @@
 str
 </dd>
 </dl>
+<a NAME="CodeStyleCheckerDialog.__assembleIncludeMessages" ID="CodeStyleCheckerDialog.__assembleIncludeMessages"></a>
+<h4>CodeStyleCheckerDialog.__assembleIncludeMessages</h4>
+<b>__assembleIncludeMessages</b>(<i></i>)
+<p>
+        Private method to assemble the list of included checks.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of included checks as a comma separated string.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a>
 <h4>CodeStyleCheckerDialog.__batchFinished</h4>
 <b>__batchFinished</b>(<i></i>)
@@ -374,13 +393,6 @@
         Private slot handling the completion of a batch job.
 </p>
 
-<a NAME="CodeStyleCheckerDialog.__cleanupData" ID="CodeStyleCheckerDialog.__cleanupData"></a>
-<h4>CodeStyleCheckerDialog.__cleanupData</h4>
-<b>__cleanupData</b>(<i></i>)
-<p>
-        Private method to clean the loaded/entered data of redundant entries.
-</p>
-
 <a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a>
 <h4>CodeStyleCheckerDialog.__clearErrors</h4>
 <b>__clearErrors</b>(<i>files</i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.NameOrderChecker.html	Sat Feb 22 18:04:02 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.NameOrderChecker.html	Sat Feb 22 18:04:39 2025 +0100
@@ -46,6 +46,7 @@
 <h3>Class Attributes</h3>
 <table>
 <tr><td>Codes</td></tr>
+<tr><td>Prefix</td></tr>
 </table>
 
 <h3>Class Methods</h3>
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html	Sat Feb 22 18:04:02 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html	Sat Feb 22 18:04:39 2025 +0100
@@ -53,7 +53,7 @@
 <table>
 <tr>
 <td><a href="#NamingStyleChecker.__init__">NamingStyleChecker</a></td>
-<td>Constructor (according to 'extended' pycodestyle.py API)</td>
+<td>Constructor</td>
 </tr>
 <tr>
 <td><a href="#NamingStyleChecker.__checkClassName">__checkClassName</a></td>
@@ -120,6 +120,10 @@
 <td>Private method to determine the error code for a variable in global scope.</td>
 </tr>
 <tr>
+<td><a href="#NamingStyleChecker.__ignoreCode">__ignoreCode</a></td>
+<td>Private method to check if the message code should be ignored.</td>
+</tr>
+<tr>
 <td><a href="#NamingStyleChecker.__isMixedCase">__isMixedCase</a></td>
 <td>Private method to check, if the given name is mixed case.</td>
 </tr>
@@ -161,24 +165,44 @@
 
 <a NAME="NamingStyleChecker.__init__" ID="NamingStyleChecker.__init__"></a>
 <h4>NamingStyleChecker (Constructor)</h4>
-<b>NamingStyleChecker</b>(<i>tree, filename, options</i>)
+<b>NamingStyleChecker</b>(<i>source, filename, tree, select, ignore, expected, repeat, args</i>)
 <p>
-        Constructor (according to 'extended' pycodestyle.py API)
+        Constructor
 </p>
 
 <dl>
 
-<dt><i>tree</i> (ast.AST)</dt>
+<dt><i>source</i> (list of str)</dt>
 <dd>
-AST tree of the source file
+source code to be checked
 </dd>
 <dt><i>filename</i> (str)</dt>
 <dd>
 name of the source file
 </dd>
-<dt><i>options</i> (optparse.Option)</dt>
+<dt><i>tree</i> (ast.Module)</dt>
+<dd>
+AST tree of the source code
+</dd>
+<dt><i>select</i> (list of str)</dt>
+<dd>
+list of selected codes
+</dd>
+<dt><i>ignore</i> (list of str)</dt>
 <dd>
-options as parsed by pycodestyle.StyleGuide
+list of codes to be ignored
+</dd>
+<dt><i>expected</i> (list of str)</dt>
+<dd>
+list of expected codes
+</dd>
+<dt><i>repeat</i> (bool)</dt>
+<dd>
+flag indicating to report each occurrence of a code
+</dd>
+<dt><i>args</i> (dict)</dt>
+<dd>
+dictionary of arguments for the various checks
 </dd>
 </dl>
 <a NAME="NamingStyleChecker.__checkClassName" ID="NamingStyleChecker.__checkClassName"></a>
@@ -204,18 +228,6 @@
 list of parent nodes
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__checkFunctionArgumentNames" ID="NamingStyleChecker.__checkFunctionArgumentNames"></a>
 <h4>NamingStyleChecker.__checkFunctionArgumentNames</h4>
 <b>__checkFunctionArgumentNames</b>(<i>node, _parents</i>)
@@ -240,18 +252,6 @@
 list of parent nodes (unused)
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__checkFunctionName" ID="NamingStyleChecker.__checkFunctionName"></a>
 <h4>NamingStyleChecker.__checkFunctionName</h4>
 <b>__checkFunctionName</b>(<i>node, _parents</i>)
@@ -278,18 +278,6 @@
 list of parent nodes (unused)
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__checkImportAs" ID="NamingStyleChecker.__checkImportAs"></a>
 <h4>NamingStyleChecker.__checkImportAs</h4>
 <b>__checkImportAs</b>(<i>node, _parents</i>)
@@ -309,18 +297,6 @@
 list of parent nodes (unused)
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__checkModule" ID="NamingStyleChecker.__checkModule"></a>
 <h4>NamingStyleChecker.__checkModule</h4>
 <b>__checkModule</b>(<i>node, _parents</i>)
@@ -342,18 +318,6 @@
 list of parent nodes (unused)
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__checkNameToBeAvoided" ID="NamingStyleChecker.__checkNameToBeAvoided"></a>
 <h4>NamingStyleChecker.__checkNameToBeAvoided</h4>
 <b>__checkNameToBeAvoided</b>(<i>node, _parents</i>)
@@ -372,18 +336,6 @@
 list of parent nodes (unused)
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__checkVariableNames" ID="NamingStyleChecker.__checkVariableNames"></a>
 <h4>NamingStyleChecker.__checkVariableNames</h4>
 <b>__checkVariableNames</b>(<i>node, parents</i>)
@@ -406,18 +358,6 @@
 list of parent nodes
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__classVariableCheck" ID="NamingStyleChecker.__classVariableCheck"></a>
 <h4>NamingStyleChecker.__classVariableCheck</h4>
 <b>__classVariableCheck</b>(<i>name</i>)
@@ -462,18 +402,6 @@
 error code to report
 </dd>
 </dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__extractNames" ID="NamingStyleChecker.__extractNames"></a>
 <h4>NamingStyleChecker.__extractNames</h4>
 <b>__extractNames</b>(<i>assignmentTarget</i>)
@@ -532,18 +460,6 @@
 list of parent nodes
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__functionVariableCheck" ID="NamingStyleChecker.__functionVariableCheck"></a>
 <h4>NamingStyleChecker.__functionVariableCheck</h4>
 <b>__functionVariableCheck</b>(<i>func, varName</i>)
@@ -656,6 +572,32 @@
 str or None
 </dd>
 </dl>
+<a NAME="NamingStyleChecker.__ignoreCode" ID="NamingStyleChecker.__ignoreCode"></a>
+<h4>NamingStyleChecker.__ignoreCode</h4>
+<b>__ignoreCode</b>(<i>code</i>)
+<p>
+        Private method to check if the message code should be ignored.
+</p>
+
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+message code to check for
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating to ignore the given code
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="NamingStyleChecker.__isMixedCase" ID="NamingStyleChecker.__isMixedCase"></a>
 <h4>NamingStyleChecker.__isMixedCase</h4>
 <b>__isMixedCase</b>(<i>name</i>)
@@ -797,18 +739,6 @@
 AST tree node to inspect
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__visitTree" ID="NamingStyleChecker.__visitTree"></a>
 <h4>NamingStyleChecker.__visitTree</h4>
 <b>__visitTree</b>(<i>node</i>)
@@ -823,18 +753,6 @@
 AST tree node to scan
 </dd>
 </dl>
-<dl>
-<dt>Yield:</dt>
-<dd>
-tuple giving line number, offset within line and error code
-</dd>
-</dl>
-<dl>
-<dt>Yield Type:</dt>
-<dd>
-tuple of (int, int, str)
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.run" ID="NamingStyleChecker.run"></a>
 <h4>NamingStyleChecker.run</h4>
 <b>run</b>(<i></i>)

eric ide

mercurial