diff -r 47be220abdaf -r 779cda568acb src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/DocStyleChecker.py
--- a/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/DocStyleChecker.py Tue Apr 16 15:47:11 2024 +0200
+++ b/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/DocStyleChecker.py Sat Apr 20 18:01:36 2024 +0200
@@ -813,14 +813,14 @@
self.__error(docstringContext.end(), 0, "D206")
return
- def __checkTripleDoubleQuotes(self, docstringContext, context): # noqa: U100
+ def __checkTripleDoubleQuotes(self, docstringContext, _context):
"""
Private method to check, that all docstrings are surrounded
by triple double quotes.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -830,14 +830,14 @@
if not docstring.startswith(('"""', 'r"""', 'u"""')):
self.__error(docstringContext.start(), 0, "D111")
- def __checkBackslashes(self, docstringContext, context): # noqa: U100
+ def __checkBackslashes(self, docstringContext, _context):
"""
Private method to check, that all docstrings containing
backslashes are surrounded by raw triple double quotes.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -902,13 +902,13 @@
if indent != expectedIndent:
self.__error(docstringContext.start(), 0, "D122")
- def __checkSummary(self, docstringContext, context): # noqa: U100
+ def __checkSummary(self, docstringContext, _context):
"""
Private method to check, that docstring summaries contain some text.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -918,13 +918,13 @@
if summary == "":
self.__error(docstringContext.start() + lineNumber, 0, "D130")
- def __checkEndsWithPeriod(self, docstringContext, context): # noqa: U100
+ def __checkEndsWithPeriod(self, docstringContext, _context):
"""
Private method to check, that docstring summaries end with a period.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -934,14 +934,14 @@
if not summary.endswith("."):
self.__error(docstringContext.start() + lineNumber, 0, "D131")
- def __checkImperativeMood(self, docstringContext, context): # noqa: U100
+ def __checkImperativeMood(self, docstringContext, _context):
"""
Private method to check, that docstring summaries are in
imperative mood.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1066,14 +1066,14 @@
if contextLines[end + 1].strip():
self.__error(docstringContext.end(), 0, "D143")
- def __checkBlankAfterSummary(self, docstringContext, context): # noqa: U100
+ def __checkBlankAfterSummary(self, docstringContext, _context):
"""
Private method to check, that docstring summaries are followed
by a blank line.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1088,14 +1088,14 @@
if len(docstrings) > 2 and docstrings[lineNumber + 1].strip():
self.__error(docstringContext.start() + lineNumber, 0, "D144")
- def __checkBlankAfterLastParagraph(self, docstringContext, context): # noqa: U100
+ def __checkBlankAfterLastParagraph(self, docstringContext, _context):
"""
Private method to check, that the last paragraph of docstrings is
followed by a blank line.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1113,14 +1113,14 @@
## Checking functionality below (eric specific ones)
##################################################################
- def __checkEricQuotesOnSeparateLines(self, docstringContext, context): # noqa: U100
+ def __checkEricQuotesOnSeparateLines(self, docstringContext, _context):
"""
Private method to check, that leading and trailing quotes are on
a line by themselves.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1132,13 +1132,13 @@
if lines[-1].strip().strip("\"'"):
self.__error(docstringContext.end(), 0, "D222")
- def __checkEricEndsWithPeriod(self, docstringContext, context): # noqa: U100
+ def __checkEricEndsWithPeriod(self, docstringContext, _context):
"""
Private method to check, that docstring summaries end with a period.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1393,14 +1393,14 @@
if signal not in definedSignals:
self.__error(docstringContext.end(), 0, "D263", signal)
- def __checkEricBlankAfterSummary(self, docstringContext, context): # noqa: U100
+ def __checkEricBlankAfterSummary(self, docstringContext, _context):
"""
Private method to check, that docstring summaries are followed
by a blank line.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1476,16 +1476,14 @@
self.__error(docstringContext.end(), 0, "D245")
- def __checkEricNBlankAfterLastParagraph(
- self, docstringContext, context # noqa: U100
- ):
+ def __checkEricNBlankAfterLastParagraph(self, docstringContext, _context):
"""
Private method to check, that the last paragraph of docstrings is
not followed by a blank line.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1614,7 +1612,7 @@
def __checkEricDocumentationSequence(
self,
docstringContext,
- context, # noqa: U100
+ _context,
):
"""
Private method to check, that method docstring follows the correct sequence
@@ -1622,7 +1620,7 @@
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1669,14 +1667,14 @@
def __checkEricDocumentationDeprecatedTags(
self,
docstringContext,
- context, # noqa: U100
+ _context,
):
"""
Private method to check the use of deprecated documentation tags.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None:
@@ -1707,14 +1705,14 @@
def __checkEricDocumentationIndent(
self,
docstringContext,
- context, # noqa: U100
+ _context,
):
"""
Private method to check the the correct indentation of the tag lines.
@param docstringContext docstring context
@type DocStyleContext
- @param context context of the docstring
+ @param _context context of the docstring (unused)
@type DocStyleContext
"""
if docstringContext is None or not docstringContext.source():
