src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html

branch
eric7
changeset 11150
73d80859079c
parent 11144
8c40c5e1ebe0
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html	Thu Feb 27 09:22:15 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html	Thu Feb 27 14:42:39 2025 +0100
@@ -38,9 +38,10 @@
 </p>
 
 <h3>Derived from</h3>
-None
+CodeStyleTopicChecker
 <h3>Class Attributes</h3>
 <table>
+<tr><td>Category</td></tr>
 <tr><td>Codes</td></tr>
 </table>
 
@@ -88,10 +89,6 @@
 <td>Private method to determine the error code for a variable in class scope.</td>
 </tr>
 <tr>
-<td><a href="#NamingStyleChecker.__error">__error</a></td>
-<td>Private method to build the error information.</td>
-</tr>
-<tr>
 <td><a href="#NamingStyleChecker.__extractNames">__extractNames</a></td>
 <td>Private method to extract the names from the target node.</td>
 </tr>
@@ -120,10 +117,6 @@
 <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>
@@ -152,8 +145,12 @@
 <td>Private method to scan the given AST tree.</td>
 </tr>
 <tr>
+<td><a href="#NamingStyleChecker.addErrorFromNode">addErrorFromNode</a></td>
+<td>Public method to build the error information.</td>
+</tr>
+<tr>
 <td><a href="#NamingStyleChecker.run">run</a></td>
-<td>Public method run by the pycodestyle.py checker.</td>
+<td>Public method to execute the relevant checks.</td>
 </tr>
 </table>
 
@@ -384,24 +381,6 @@
 str or None
 </dd>
 </dl>
-<a NAME="NamingStyleChecker.__error" ID="NamingStyleChecker.__error"></a>
-<h4>NamingStyleChecker.__error</h4>
-<b>__error</b>(<i>node, code</i>)
-<p>
-        Private method to build the error information.
-</p>
-
-<dl>
-
-<dt><i>node</i> (ast.AST)</dt>
-<dd>
-AST node to report an error for
-</dd>
-<dt><i>code</i> (str)</dt>
-<dd>
-error code to report
-</dd>
-</dl>
 <a NAME="NamingStyleChecker.__extractNames" ID="NamingStyleChecker.__extractNames"></a>
 <h4>NamingStyleChecker.__extractNames</h4>
 <b>__extractNames</b>(<i>assignmentTarget</i>)
@@ -572,32 +551,6 @@
 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>)
@@ -753,26 +706,31 @@
 AST tree node to scan
 </dd>
 </dl>
+<a NAME="NamingStyleChecker.addErrorFromNode" ID="NamingStyleChecker.addErrorFromNode"></a>
+<h4>NamingStyleChecker.addErrorFromNode</h4>
+<b>addErrorFromNode</b>(<i>node, msgCode</i>)
+<p>
+        Public method to build the error information.
+</p>
+
+<dl>
+
+<dt><i>node</i> (ast.AST)</dt>
+<dd>
+AST node to report an error for
+</dd>
+<dt><i>msgCode</i> (str)</dt>
+<dd>
+message code
+</dd>
+</dl>
 <a NAME="NamingStyleChecker.run" ID="NamingStyleChecker.run"></a>
 <h4>NamingStyleChecker.run</h4>
 <b>run</b>(<i></i>)
 <p>
-        Public method run by the pycodestyle.py checker.
+        Public method to execute the relevant checks.
 </p>
 
-<dl>
-<dt>Return:</dt>
-<dd>
-tuple giving line number, offset within line, code and
-            checker function
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-tuple of (int, int, str, function)
-</dd>
-</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>

eric ide

mercurial