diff -r 779cda568acb -r 58c7f23ae1cb src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html --- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Sat Apr 20 18:01:36 2024 +0200 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Sat Apr 20 18:02:35 2024 +0200 @@ -295,7 +295,7 @@ </dl> <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> <h4>DocStyleChecker.__checkBackslashes</h4> -<b>__checkBackslashes</b>(<i>docstringContext, context</i>) +<b>__checkBackslashes</b>(<i>docstringContext, _context</i>) <p> Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes. @@ -307,14 +307,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4> -<b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, _context</i>) <p> Private method to check, that the last paragraph of docstrings is followed by a blank line. @@ -326,14 +326,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> <h4>DocStyleChecker.__checkBlankAfterSummary</h4> -<b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) +<b>__checkBlankAfterSummary</b>(<i>docstringContext, _context</i>) <p> Private method to check, that docstring summaries are followed by a blank line. @@ -345,9 +345,9 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> @@ -390,7 +390,7 @@ </dl> <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> <h4>DocStyleChecker.__checkEndsWithPeriod</h4> -<b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) +<b>__checkEndsWithPeriod</b>(<i>docstringContext, _context</i>) <p> Private method to check, that docstring summaries end with a period. </p> @@ -401,14 +401,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4> -<b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) +<b>__checkEricBlankAfterSummary</b>(<i>docstringContext, _context</i>) <p> Private method to check, that docstring summaries are followed by a blank line. @@ -420,14 +420,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricDocumentationDeprecatedTags" ID="DocStyleChecker.__checkEricDocumentationDeprecatedTags"></a> <h4>DocStyleChecker.__checkEricDocumentationDeprecatedTags</h4> -<b>__checkEricDocumentationDeprecatedTags</b>(<i>docstringContext, context, </i>) +<b>__checkEricDocumentationDeprecatedTags</b>(<i>docstringContext, _context, </i>) <p> Private method to check the use of deprecated documentation tags. </p> @@ -438,14 +438,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricDocumentationIndent" ID="DocStyleChecker.__checkEricDocumentationIndent"></a> <h4>DocStyleChecker.__checkEricDocumentationIndent</h4> -<b>__checkEricDocumentationIndent</b>(<i>docstringContext, context, </i>) +<b>__checkEricDocumentationIndent</b>(<i>docstringContext, _context, </i>) <p> Private method to check the the correct indentation of the tag lines. </p> @@ -456,14 +456,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricDocumentationSequence" ID="DocStyleChecker.__checkEricDocumentationSequence"></a> <h4>DocStyleChecker.__checkEricDocumentationSequence</h4> -<b>__checkEricDocumentationSequence</b>(<i>docstringContext, context, </i>) +<b>__checkEricDocumentationSequence</b>(<i>docstringContext, _context, </i>) <p> Private method to check, that method docstring follows the correct sequence of entries (e.g. @param is followed by @type). @@ -475,14 +475,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4> -<b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) +<b>__checkEricEndsWithPeriod</b>(<i>docstringContext, _context</i>) <p> Private method to check, that docstring summaries end with a period. </p> @@ -493,9 +493,9 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> @@ -543,7 +543,7 @@ </dl> <a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a> <h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4> -<b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, _context</i>) <p> Private method to check, that the last paragraph of docstrings is not followed by a blank line. @@ -555,9 +555,9 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> @@ -581,7 +581,7 @@ </dl> <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4> -<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) +<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, _context</i>) <p> Private method to check, that leading and trailing quotes are on a line by themselves. @@ -593,9 +593,9 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> @@ -700,7 +700,7 @@ </dl> <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> <h4>DocStyleChecker.__checkImperativeMood</h4> -<b>__checkImperativeMood</b>(<i>docstringContext, context</i>) +<b>__checkImperativeMood</b>(<i>docstringContext, _context</i>) <p> Private method to check, that docstring summaries are in imperative mood. @@ -712,9 +712,9 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> @@ -830,7 +830,7 @@ </dl> <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> <h4>DocStyleChecker.__checkSummary</h4> -<b>__checkSummary</b>(<i>docstringContext, context</i>) +<b>__checkSummary</b>(<i>docstringContext, _context</i>) <p> Private method to check, that docstring summaries contain some text. </p> @@ -841,14 +841,14 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4> -<b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) +<b>__checkTripleDoubleQuotes</b>(<i>docstringContext, _context</i>) <p> Private method to check, that all docstrings are surrounded by triple double quotes. @@ -860,9 +860,9 @@ <dd> docstring context </dd> -<dt><i>context</i> (DocStyleContext)</dt> +<dt><i>_context</i> (DocStyleContext)</dt> <dd> -context of the docstring +context of the docstring (unused) </dd> </dl> <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>