Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html	Fri Dec 22 19:45:17 2023 +0100
@@ -170,15 +170,15 @@
 </p>
 <dl>
 
-<dt><i>tree</i></dt>
+<dt><i>tree</i> (ast.AST)</dt>
 <dd>
 AST tree of the source file
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-name of the source file (string)
+name of the source file
 </dd>
-<dt><i>options</i></dt>
+<dt><i>options</i> (optparse.Option)</dt>
 <dd>
 options as parsed by pycodestyle.StyleGuide
 </dd>
@@ -197,11 +197,11 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.ClassDef)</dt>
 <dd>
 AST note to check
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -233,11 +233,11 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.FunctionDef or ast.AsynFunctionDef)</dt>
 <dd>
 AST note to check
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -271,11 +271,11 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.FunctionDef or ast.AsynFunctionDef)</dt>
 <dd>
 AST note to check
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -302,11 +302,11 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.Import)</dt>
 <dd>
-AST note to check
+AST node to check
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -335,11 +335,11 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.AST)</dt>
 <dd>
-AST note to check
+AST node to check
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -365,11 +365,11 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.Ast)</dt>
 <dd>
 AST note to check
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -399,11 +399,11 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.AST)</dt>
 <dd>
 AST note to check
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -455,20 +455,25 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.AST)</dt>
 <dd>
 AST node to report an error for
 </dd>
-<dt><i>code</i></dt>
+<dt><i>code</i> (str)</dt>
 <dd>
-error code to report (string)
+error code to report
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 tuple giving line number, offset within line and error code
-            (integer, integer, string)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int, str)
 </dd>
 </dl>
 <a NAME="NamingStyleChecker.__extractNames" ID="NamingStyleChecker.__extractNames"></a>
@@ -506,7 +511,7 @@
 </p>
 <dl>
 
-<dt><i>functionNode</i></dt>
+<dt><i>functionNode</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt>
 <dd>
 AST tree node to amend
 </dd>
@@ -580,7 +585,7 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt>
 <dd>
 AST node to extract arguments names from
 </dd>
@@ -588,7 +593,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of argument names (list of string)
+list of argument names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="NamingStyleChecker.__getClassdef" ID="NamingStyleChecker.__getClassdef"></a>
@@ -604,7 +615,7 @@
 <dd>
 name of the class
 </dd>
-<dt><i>parents</i> (ast.AST)</dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -682,15 +693,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name to be checked (string)
+name to be checked
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating to avoid it (boolen)
+flag indicating to avoid it
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="NamingStyleChecker.__isNamedTupel" ID="NamingStyleChecker.__isNamedTupel"></a>
@@ -732,7 +749,7 @@
 <dd>
 name of the class
 </dd>
-<dt><i>parents</i> (ast.AST)</dt>
+<dt><i>parents</i> (list of ast.AST)</dt>
 <dd>
 list of parent nodes
 </dd>
@@ -763,7 +780,7 @@
 </p>
 <dl>
 
-<dt><i>classNode</i></dt>
+<dt><i>classNode</i> (ast.ClassDef)</dt>
 <dd>
 AST tree node to tag
 </dd>
@@ -777,7 +794,7 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.AST)</dt>
 <dd>
 AST tree node to inspect
 </dd>
@@ -803,7 +820,7 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.AST)</dt>
 <dd>
 AST tree node to scan
 </dd>
@@ -834,6 +851,12 @@
             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>
\ No newline at end of file