Mercurial Repositories > eric / file diff

--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html	Sat Jan 16 16:50:00 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html	Sat Jan 16 16:51:23 2021 +0100
@@ -141,6 +141,10 @@
 <td>Private method to check, that method docstring summaries start with specific words.</td>
 </tr>
 <tr>
+<td><a href="#DocStyleChecker.__checkEricYield">__checkEricYield</a></td>
+<td>Private method to check, that docstrings contain an &#64;yield line if they return anything and don't otherwise.</td>
+</tr>
+<tr>
 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td>
 <td>Private method to check, that all public functions and methods have a docstring.</td>
 </tr>
@@ -611,6 +615,25 @@
 context of the docstring (DocStyleContext)
 </dd>
 </dl>
+<a NAME="DocStyleChecker.__checkEricYield" ID="DocStyleChecker.__checkEricYield"></a>
+<h4>DocStyleChecker.__checkEricYield</h4>
+<b>__checkEricYield</b>(<i>docstringContext, context</i>)
+
+<p>
+        Private method to check, that docstrings contain an &#64;yield line
+        if they return anything and don't otherwise.
+</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.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a>
 <h4>DocStyleChecker.__checkFunctionDocstring</h4>
 <b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>)
@@ -838,7 +861,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of two list of argument names, one for arguments
             and one for keyword arguments (tuple of list of string)
@@ -859,7 +882,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 summary line (string) and the line it was found on (integer)
 </dd>
@@ -879,7 +902,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 summary lines (list of string) and the line it was found on
             (integer)
@@ -900,7 +923,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating to ignore the given code (boolean)
 </dd>
@@ -913,7 +936,7 @@
         Private method to extract top-level classes.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 extracted class contexts (list of DocStyleContext)
 </dd>
@@ -933,7 +956,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 requested contexts (list of DocStyleContext)
 </dd>
@@ -957,7 +980,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 context of extracted docstring (DocStyleContext)
 </dd>
@@ -970,7 +993,7 @@
         Private method to extract top-level functions.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 extracted function contexts (list of DocStyleContext)
 </dd>
@@ -983,7 +1006,7 @@
         Private method to extract methods of all classes.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 extracted method contexts (list of DocStyleContext)
 </dd>
@@ -1003,7 +1026,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 context of extracted docstring (DocStyleContext)
 </dd>
@@ -1023,7 +1046,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 extracted function or class contexts (list of DocStyleContext)
 </dd>
@@ -1036,7 +1059,7 @@
         Private method to get the next line from the source.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 next line of source (string)
 </dd>
@@ -1070,7 +1093,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 last token of the indented block
 </dd>
@@ -1181,7 +1204,7 @@
         Public method to get the context type.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 context type (string)
 </dd>
@@ -1194,7 +1217,7 @@
         Public method to get the end line number.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 end line number (integer)
 </dd>
@@ -1207,7 +1230,7 @@
         Public method to get the indentation of the first line.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 indentation string (string)
 </dd>
@@ -1234,7 +1257,7 @@
         Public method to get the source.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 source (list of string)
 </dd>
@@ -1247,7 +1270,7 @@
         Public method to get the special context attribute string.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 attribute string
 </dd>
@@ -1266,7 +1289,7 @@
         Public method to get the joined source lines.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 source (string)
 </dd>
@@ -1279,7 +1302,7 @@
         Public method to get the start line number.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 start line number (integer)
 </dd>