Skip to content

Commit 316fc0d

Browse files
Eli FinePierre-Sassoulas
Eli Fine
authored andcommitted
fixing comments to break into multiple lines
1 parent a9bb2ad commit 316fc0d

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

pylint/checkers/spelling.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ class SpellingChecker(BaseTokenChecker):
278278
"default": "fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:",
279279
"type": "string",
280280
"metavar": "<comma separated words>",
281-
"help": "List of comma separated words that should not be considered directives if they appear and the beginning of a comment and should not be checked.",
281+
"help": "List of comma separated words that should be considered directives if they appear and the beginning of a comment and should not be checked.",
282282
},
283283
),
284284
)

tests/checkers/unittest_spelling.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@
3737
pass
3838

3939

40-
class TestSpellingChecker(
41-
CheckerTestCase
42-
): # pylint:disable=too-many-public-methods # This is a test case class, not sure why it would be relevant to have this pylint rule enforced for test case classes
40+
class TestSpellingChecker(CheckerTestCase): # pylint:disable=too-many-public-methods
41+
# This is a test case class, not sure why it would be relevant to have
42+
# this pylint rule enforced for test case classes.
4343
CHECKER_CLASS = spelling.SpellingChecker
4444

4545
skip_on_missing_package_or_dict = pytest.mark.skipif(
@@ -325,8 +325,14 @@ def test_skip_sphinx_directives_2(self):
325325
("mypy", ":", "mypy directive"),
326326
),
327327
)
328-
def test_skip_tool_directives_at_beginning_of_comments_but_still_raise_error_if_directive_appears_later_in_comment( # pylint:disable=unused-argument # Having the extra description parameter allows the description to show up in the pytest output as part of the test name when running parametrized tests
329-
self, misspelled_portion_of_directive, second_portion_of_directive, description
328+
def test_skip_tool_directives_at_beginning_of_comments_but_still_raise_error_if_directive_appears_later_in_comment( # pylint:disable=unused-argument
329+
# Having the extra description parameter allows the description
330+
# to show up in the pytest output as part of the test name
331+
# when running parametrized tests.
332+
self,
333+
misspelled_portion_of_directive,
334+
second_portion_of_directive,
335+
description,
330336
):
331337
full_comment = f"# {misspelled_portion_of_directive}{second_portion_of_directive} {misspelled_portion_of_directive}"
332338
with self.assertAddsMessages(

0 commit comments

Comments
 (0)