diff options
| author |  kwzrd <[email protected]> | 2020-01-31 20:14:43 +0100 |
|---|---|---|
| committer | kwzrd <[email protected]> | 2020-01-31 20:14:43 +0100 |
| commit | 8456331140bdd6bdc1d2c8bf395b69febef45ad8 (patch) | |
| tree | 0342c2c3d16d78ef228fea13e8415f831a990a7e | |
| parent | Refactor msg helper function name to make_msg (diff) | |
Adjust multi-line docstrings to prevailing style
| -rw-r--r-- | tests/bot/rules/test_burst.py | 3 | ||||
| -rw-r--r-- | tests/bot/rules/test_burst_shared.py | 6 |
2 files changed, 6 insertions, 3 deletions
diff --git a/tests/bot/rules/test_burst.py b/tests/bot/rules/test_burst.py index 4da0cc78e..afcc5554d 100644 --- a/tests/bot/rules/test_burst.py +++ b/tests/bot/rules/test_burst.py @@ -5,7 +5,8 @@ from tests.helpers import MockMessage, async_test def make_msg(author: str) -> MockMessage: - """Init a MockMessage instance with author set to `author`. + """ + Init a MockMessage instance with author set to `author`. This serves as a shorthand / alias to keep the test cases visually clean. """ diff --git a/tests/bot/rules/test_burst_shared.py b/tests/bot/rules/test_burst_shared.py index 1f5662eff..401e0b666 100644 --- a/tests/bot/rules/test_burst_shared.py +++ b/tests/bot/rules/test_burst_shared.py @@ -5,7 +5,8 @@ from tests.helpers import MockMessage, async_test def make_msg(author: str) -> MockMessage: - """Init a MockMessage instance with the passed arg. + """ + Init a MockMessage instance with the passed arg. This serves as a shorthand / alias to keep the test cases visually clean. """ @@ -20,7 +21,8 @@ class BurstSharedRuleTests(unittest.TestCase): @async_test async def test_allows_messages_within_limit(self): - """Cases that do not violate the rule. + """ + Cases that do not violate the rule. There really isn't more to test here than a single case. """ |