eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html

changeset 7641
21ea4fd50b0a
parent 7273
391d6b7b1eff
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Fri Jul 03 17:37:11 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Sat Jul 04 11:34:37 2020 +0200
@@ -181,16 +181,12 @@
 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td>
 </tr>
 <tr>
-<td><a href="#DocStyleChecker.__checkUnicode">__checkUnicode</a></td>
-<td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td>
-</tr>
-<tr>
 <td><a href="#DocStyleChecker.__error">__error</a></td>
 <td>Private method to record an issue.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td>
-<td></td>
+<td>Private method to get the argument names of a function node.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td>
@@ -252,10 +248,6 @@
 <td><a href="#DocStyleChecker.run">run</a></td>
 <td>Public method to check the given source for violations of doc string conventions.</td>
 </tr>
-<tr>
-<td><a href="#DocStyleChecker.unpackArgs">unpackArgs</a></td>
-<td>Local helper function to unpack function argument names.</td>
-</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -805,25 +797,6 @@
 context of the docstring (DocStyleContext)
 </dd>
 </dl>
-<a NAME="DocStyleChecker.__checkUnicode" ID="DocStyleChecker.__checkUnicode"></a>
-<h4>DocStyleChecker.__checkUnicode</h4>
-<b>__checkUnicode</b>(<i>docstringContext, context</i>)
-
-<p>
-        Private method to check, that all docstrings containing unicode
-        characters are surrounded by unicode triple double quotes.
-</p>
-<dl>
-
-<dt><i>docstringContext</i></dt>
-<dd>
-docstring context (DocStyleContext)
-</dd>
-<dt><i>context</i></dt>
-<dd>
-context of the docstring (DocStyleContext)
-</dd>
-</dl>
 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>
 <h4>DocStyleChecker.__error</h4>
 <b>__error</b>(<i>lineNumber, offset, code, *args</i>)
@@ -854,6 +827,23 @@
 <h4>DocStyleChecker.__getArgNames</h4>
 <b>__getArgNames</b>(<i>node</i>)
 
+<p>
+        Private method to get the argument names of a function node.
+</p>
+<dl>
+
+<dt><i>node</i></dt>
+<dd>
+AST node to extract arguments names from
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+tuple of two list of argument names, one for arguments
+            and one for keyword arguments (tuple of list of string)
+</dd>
+</dl>
 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a>
 <h4>DocStyleChecker.__getSummaryLine</h4>
 <b>__getSummaryLine</b>(<i>docstringContext</i>)
@@ -1093,26 +1083,6 @@
         Public method to check the given source for violations of doc string
         conventions.
 </p>
-<a NAME="DocStyleChecker.unpackArgs" ID="DocStyleChecker.unpackArgs"></a>
-<h4>DocStyleChecker.unpackArgs</h4>
-<b>unpackArgs</b>(<i></i>)
-
-<p>
-                Local helper function to unpack function argument names.
-</p>
-<dl>
-
-<dt><i>args</i></dt>
-<dd>
-list of AST node arguments
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of argument names (list of string)
-</dd>
-</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />

eric ide

mercurial