Mercurial Repositories > eric / file diff

diff -r e67c1c4f4abb -r 34041e56ec42 Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Sat May 06 13:37:05 2017 +0200
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Sat May 06 14:59:26 2017 +0200
@@ -105,6 +105,9 @@
 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td>
 <td>Private method to check, that docstrings contain an &#64;return line if they return anything and don't otherwise.</td>
 </tr><tr>
+<td><a href="#DocStyleChecker.__checkEricSignal">__checkEricSignal</a></td>
+<td>Private method to check, that docstrings contain an &#64;signal line if they define signals and don't otherwise.</td>
+</tr><tr>
 <td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td>
 <td>Private method to check, that method docstring summaries start with specific words.</td>
 </tr><tr>
@@ -349,6 +352,10 @@
 <p>
         Private method to check, that docstrings contain an &#64;exception line
         if they raise an exception and don't otherwise.
+</p><p>
+        Note: This method also checks the raised and documented exceptions for
+        completeness (i.e. raised exceptions that are not documented or
+        documented exceptions that are not raised)
 </p><dl>
 <dt><i>docstringContext</i></dt>
 <dd>
@@ -427,6 +434,24 @@
 <dd>
 context of the docstring (DocStyleContext)
 </dd>
+</dl><a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a>
+<h4>DocStyleChecker.__checkEricSignal</h4>
+<b>__checkEricSignal</b>(<i>docstringContext, context</i>)
+<p>
+        Private method to check, that docstrings contain an &#64;signal line
+        if they define signals and don't otherwise.
+</p><p>
+        Note: This method also checks the defined and documented signals for
+        completeness (i.e. defined signals that are not documented or
+        documented signals that are not defined)
+</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.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a>
 <h4>DocStyleChecker.__checkEricSummary</h4>
 <b>__checkEricSummary</b>(<i>docstringContext, context</i>)