Skip to content

Commit 5da2c2a

Browse files
committed
style: standardize docstrings
1 parent 527a454 commit 5da2c2a

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

src/mailrise/basic_authenticator.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99

1010
class BasicAuthenticator(typ.NamedTuple):
11-
"""A simple authenticator that uses a static username and password list.
12-
"""
11+
"""A simple authenticator that uses a static username and password list."""
1312
logins: typ.Mapping[str, str]
1413

1514
# pylint: disable=too-many-arguments

src/mailrise/smtp.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ class AppriseNotifyFailure(Exception):
3333
"""Exception raised when Apprise fails to deliver a notification.
3434
3535
Note: Apprise does not provide any information about the reason for the
36-
failure."""
36+
failure.
37+
"""
3738

3839

3940
class UnreadableMultipart(Exception):

tests/noop_pluggable.py

+3-9
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@
1515
# in handy when developing your code.
1616

1717
class FullyTypedNoopRouter(Router): # pylint: disable=too-few-public-methods
18-
"""
19-
A dummy custom router with full typing information.
20-
"""
18+
"""A dummy custom router with full typing information."""
2119
async def email_to_apprise(
2220
self, logger: Logger, email: EmailMessage, auth_data: Any, **kwargs) \
2321
-> AsyncGenerator[AppriseNotification, None]:
@@ -27,9 +25,7 @@ async def email_to_apprise(
2725
body='Lorem ipsum dolor sit amet')
2826

2927
class EasyNoopRouter: # pylint: disable=too-few-public-methods
30-
"""
31-
A dummy custom router with the minimum required code.
32-
"""
28+
"""A dummy custom router with the minimum required code."""
3329
async def email_to_apprise(self, _logger, _email, _auth_data, **_kwargs):
3430
"""Our replacement for email_to_apprise()."""
3531
# An ordinary dictionary will not work; we need dot notation access.
@@ -45,9 +41,7 @@ async def email_to_apprise(self, _logger, _email, _auth_data, **_kwargs):
4541
# communicate that to mypy.
4642

4743
def noop_authenticator(_server, _session, _envelope, _mechanism, _auth_data):
48-
"""
49-
A dummy custom authenticator.
50-
"""
44+
"""A dummy custom authenticator."""
5145
return AuthResult(success=False)
5246

5347

0 commit comments

Comments
 (0)