Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html	Fri Oct 27 14:09:40 2023 +0200
@@ -64,15 +64,15 @@
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkBackslashes">__checkBackslashes</a></td>
-<td></td>
+<td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td>
-<td></td>
+<td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td>
-<td></td>
+<td>Private method to check, that docstring summaries are followed by a blank line.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td>
@@ -84,15 +84,15 @@
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td>
-<td></td>
+<td>Private method to check, that docstring summaries end with a period.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td>
-<td></td>
+<td>Private method to check, that docstring summaries are followed by a blank line.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td>
-<td></td>
+<td>Private method to check, that docstring summaries end with a period.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td>
@@ -112,7 +112,7 @@
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td>
-<td></td>
+<td>Private method to check, that leading and trailing quotes are on a line by themselves.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td>
@@ -136,7 +136,7 @@
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td>
-<td></td>
+<td>Private method to check, that docstring summaries are in imperative mood.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td>
@@ -164,11 +164,11 @@
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td>
-<td></td>
+<td>Private method to check, that docstring summaries contain some text.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td>
-<td></td>
+<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td>
 </tr>
 <tr>
 <td><a href="#DocStyleChecker.__error">__error</a></td>
@@ -289,14 +289,59 @@
 <h4>DocStyleChecker.__checkBackslashes</h4>
 <b>__checkBackslashes</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that all docstrings containing
+        backslashes are surrounded by raw 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.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a>
 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4>
 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that the last paragraph of docstrings is
+        followed by a blank line.
+</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.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a>
 <h4>DocStyleChecker.__checkBlankAfterSummary</h4>
 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that docstring summaries are followed
+        by a blank line.
+</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.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a>
 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4>
 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>)
@@ -339,14 +384,57 @@
 <h4>DocStyleChecker.__checkEndsWithPeriod</h4>
 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that docstring summaries end with a period.
+</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.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a>
 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4>
 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that docstring summaries are followed
+        by a blank line.
+</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.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a>
 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4>
 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that docstring summaries end with a period.
+</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.__checkEricException" ID="DocStyleChecker.__checkEricException"></a>
 <h4>DocStyleChecker.__checkEricException</h4>
 <b>__checkEricException</b>(<i>docstringContext, context</i>)
@@ -432,6 +520,21 @@
 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4>
 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that leading and trailing quotes are on
+        a line by themselves.
+</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.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a>
 <h4>DocStyleChecker.__checkEricReturn</h4>
 <b>__checkEricReturn</b>(<i>docstringContext, context</i>)
@@ -536,6 +639,21 @@
 <h4>DocStyleChecker.__checkImperativeMood</h4>
 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that docstring summaries are in
+        imperative mood.
+</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.__checkIndent" ID="DocStyleChecker.__checkIndent"></a>
 <h4>DocStyleChecker.__checkIndent</h4>
 <b>__checkIndent</b>(<i>docstringContext, context</i>)
@@ -651,10 +769,39 @@
 <h4>DocStyleChecker.__checkSummary</h4>
 <b>__checkSummary</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that docstring summaries contain some text.
+</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.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a>
 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4>
 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>)
 
+<p>
+        Private method to check, that all docstrings are surrounded
+        by 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>)