diff -r e7764f992a01 -r b51dfacef37f src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Fri Oct 27 14:09:40 2023 +0200
@@ -64,23 +64,23 @@
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkFunctionArgumentNames">__checkFunctionArgumentNames</a></td>
-<td></td>
+<td>Private class to check the argument names of functions (N803, N804, N805, N806).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkFunctionName">__checkFunctionName</a></td>
-<td></td>
+<td>Private class to check the given node for function name conventions (N802, N809).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkImportAs">__checkImportAs</a></td>
-<td></td>
+<td>Private method to check that imports don't change the naming convention (N811, N812, N813, N814, N815).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkModule">__checkModule</a></td>
-<td></td>
+<td>Private method to check module naming conventions (N807, N808).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkNameToBeAvoided">__checkNameToBeAvoided</a></td>
-<td></td>
+<td>Private class to check the given node for a name to be avoided (N831).</td>
</tr>
<tr>
<td><a href="#NamingStyleChecker.__checkVariableNames">__checkVariableNames</a></td>
@@ -222,22 +222,170 @@
<h4>NamingStyleChecker.__checkFunctionArgumentNames</h4>
<b>__checkFunctionArgumentNames</b>(<i>node, parents</i>)
+<p>
+ Private class to check the argument names of functions
+ (N803, N804, N805, N806).
+</p>
+<p>
+ The argument names of a function should be lowercase, with words
+ separated by underscores. A class method should have 'cls' as the
+ first argument. A method should have 'self' as the first argument.
+</p>
+<dl>
+
+<dt><i>node</i></dt>
+<dd>
+AST note to check
+</dd>
+<dt><i>parents</i></dt>
+<dd>
+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.__checkFunctionName" ID="NamingStyleChecker.__checkFunctionName"></a>
<h4>NamingStyleChecker.__checkFunctionName</h4>
<b>__checkFunctionName</b>(<i>node, parents</i>)
+<p>
+ Private class to check the given node for function name
+ conventions (N802, N809).
+</p>
+<p>
+ Function names should be lowercase, with words separated by underscores
+ as necessary to improve readability. Functions <b>not</b> being
+ methods '__' in front and back are not allowed. Mixed case is allowed
+ only in contexts where that's already the prevailing style
+ (e.g. threading.py), to retain backwards compatibility.
+</p>
+<dl>
+
+<dt><i>node</i></dt>
+<dd>
+AST note to check
+</dd>
+<dt><i>parents</i></dt>
+<dd>
+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.__checkImportAs" ID="NamingStyleChecker.__checkImportAs"></a>
<h4>NamingStyleChecker.__checkImportAs</h4>
<b>__checkImportAs</b>(<i>node, parents</i>)
+<p>
+ Private method to check that imports don't change the
+ naming convention (N811, N812, N813, N814, N815).
+</p>
+<dl>
+
+<dt><i>node</i></dt>
+<dd>
+AST note to check
+</dd>
+<dt><i>parents</i></dt>
+<dd>
+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.__checkModule" ID="NamingStyleChecker.__checkModule"></a>
<h4>NamingStyleChecker.__checkModule</h4>
<b>__checkModule</b>(<i>node, parents</i>)
+<p>
+ Private method to check module naming conventions (N807, N808).
+</p>
+<p>
+ Module and package names should be lowercase.
+</p>
+<dl>
+
+<dt><i>node</i></dt>
+<dd>
+AST note to check
+</dd>
+<dt><i>parents</i></dt>
+<dd>
+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.__checkNameToBeAvoided" ID="NamingStyleChecker.__checkNameToBeAvoided"></a>
<h4>NamingStyleChecker.__checkNameToBeAvoided</h4>
<b>__checkNameToBeAvoided</b>(<i>node, parents</i>)
+<p>
+ Private class to check the given node for a name to be avoided (N831).
+</p>
+<dl>
+
+<dt><i>node</i></dt>
+<dd>
+AST note to check
+</dd>
+<dt><i>parents</i></dt>
+<dd>
+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.__checkVariableNames" ID="NamingStyleChecker.__checkVariableNames"></a>
<h4>NamingStyleChecker.__checkVariableNames</h4>
<b>__checkVariableNames</b>(<i>node, parents</i>)
