Mercurial Repositories > eric / file diff

diff -r 03b351be4436 -r 49f9c3695ef5 Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Sat May 17 10:39:44 2014 +0200
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Sat May 17 11:25:53 2014 +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.__checkEricSummary">__checkEricSummary</a></td>
+<td>Private method to check, that method docstring summaries start with specific words.</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><tr>
@@ -424,6 +427,20 @@
 <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>)
+<p>
+        Private method to check, that method docstring summaries start with
+        specific words.
+</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>)