Apply suggestions from code review

Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
pylint-dev · Dec 4, 2022 · 6097f34 · 6097f34
1 parent 42aba49
commit 6097f34
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 3 deletions.
diff --git a/doc/whatsnew/fragments/7827.false_positive b/doc/whatsnew/fragments/7827.false_positive
@@ -1,3 +1,3 @@
-Fix ``missing-param-doc`` false positive when function parameter has escaped underscore.
+Fix ``missing-param-doc`` false positive when function parameter has an escaped underscore.
 
 Closes #7827
diff --git a/pylint/extensions/_check_docs_utils.py b/pylint/extensions/_check_docs_utils.py
@@ -644,7 +644,6 @@ def match_param_docs(self) -> tuple[set[str], set[str]]:
         entries = self._parse_section(self.re_param_section)
         entries.extend(self._parse_section(self.re_keyword_param_section))
         for entry in entries:
-            # Remove escape characters necessary for asterisks and trailing underscores
             match = self.re_param_line.match(entry)
             if not match:
                 continue

diff --git a/tests/functional/ext/docparams/parameter/missing_param_doc_required_Google.py b/tests/functional/ext/docparams/parameter/missing_param_doc_required_Google.py
@@ -435,7 +435,7 @@ def test_finds_multiple_complex_types_google(
     )
 
 def test_escape_underscore(something: int, raise_: bool = False) -> bool:
-    """Tests param with _ is handled correctly.
+    """Tests param with escaped _ is handled correctly.
 
     Args:
         something: the something