summaryrefslogtreecommitdiff
path: root/pylint/extensions
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-07-21 10:32:45 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2022-07-21 14:50:11 +0200
commitdfb80a30a23423dbd0bf412ac69fd2328d045d8d (patch)
tree6cd434e7a72d59af64cfa1ba2d3ce72bafc886b1 /pylint/extensions
parente5b8722988b973e761f47495ac4d0a307f1fead9 (diff)
downloadpylint-git-dfb80a30a23423dbd0bf412ac69fd2328d045d8d.tar.gz
[refactor] Simplify '_add_raise_message' in the DocParam checker
Diffstat (limited to 'pylint/extensions')
-rw-r--r--pylint/extensions/docparams.py20
1 files changed, 9 insertions, 11 deletions
diff --git a/pylint/extensions/docparams.py b/pylint/extensions/docparams.py
index c3253c89e..2569be3b2 100644
--- a/pylint/extensions/docparams.py
+++ b/pylint/extensions/docparams.py
@@ -636,26 +636,24 @@ class DocstringParameterChecker(BaseChecker):
self._add_raise_message(excs, node)
def _add_raise_message(
- self, missing_excs: set[str], node: nodes.FunctionDef
+ self, missing_exceptions: set[str], node: nodes.FunctionDef
) -> None:
"""Adds a message on :param:`node` for the missing exception type.
- :param missing_excs: A list of missing exception types.
-
+ :param missing_exceptions: A list of missing exception types.
:param node: The node show the message on.
"""
if node.is_abstract():
try:
- missing_excs.remove("NotImplementedError")
+ missing_exceptions.remove("NotImplementedError")
except KeyError:
pass
-
- if not missing_excs:
- return
-
- self.add_message(
- "missing-raises-doc", args=(", ".join(sorted(missing_excs)),), node=node
- )
+ if missing_exceptions:
+ self.add_message(
+ "missing-raises-doc",
+ args=(", ".join(sorted(missing_exceptions)),),
+ node=node,
+ )
def register(linter: PyLinter) -> None: