Skip to content

Commit d90b576

Browse files
committed
tests: Add docstrings
Took me a moment to figure out how I'd broken these tests up. Signed-off-by: Stephen Finucane <[email protected]>
1 parent f066122 commit d90b576

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

tests/test_formatter.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77

88
class CommandTestCase(unittest.TestCase):
9+
"""Validate basic ``click.Command`` instances."""
10+
911
def test_no_parameters(self):
1012
"""Validate a `click.Command` with no parameters.
1113
@@ -110,8 +112,7 @@ def foobar(bar):
110112
'Allowing show_default to be a string was added in Click 7.0',
111113
)
112114
def test_defaults(self):
113-
"""Validate formatting of user documented defaults.
114-
"""
115+
"""Validate formatting of user documented defaults."""
115116

116117
@click.command()
117118
@click.option('--num-param', type=int, default=42, show_default=True)
@@ -215,6 +216,8 @@ def hello(name):
215216

216217

217218
class GroupTestCase(unittest.TestCase):
219+
"""Validate basic ``click.Group`` instances."""
220+
218221
def test_no_parameters(self):
219222
"""Validate a `click.Group` with no parameters.
220223
@@ -349,6 +352,8 @@ def cli():
349352

350353

351354
class NestedCommandsTestCase(unittest.TestCase):
355+
"""Validate ``click.Command`` instances inside ``click.Group`` instances."""
356+
352357
@staticmethod
353358
def _get_ctx():
354359
@click.group()
@@ -417,6 +422,8 @@ def test_show_nested(self):
417422

418423

419424
class CommandFilterTestCase(unittest.TestCase):
425+
"""Validate filtering of commands."""
426+
420427
@staticmethod
421428
def _get_ctx():
422429
@click.group()
@@ -487,6 +494,8 @@ def test_order_of_commands(self):
487494

488495

489496
class CustomMultiCommandTestCase(unittest.TestCase):
497+
"""Validate ``click.MultiCommand`` instances."""
498+
490499
def test_basics(self):
491500
"""Validate a custom ``click.MultiCommand`` with no parameters.
492501

0 commit comments

Comments
 (0)