Skip to content
Snippets Groups Projects
Commit d10707c8 authored by Richard van der Hoff's avatar Richard van der Hoff
Browse files

Replace inline docstrings with "Attributes" in class docstring

parent 88d34053
No related branches found
No related tags found
No related merge requests found
...@@ -37,33 +37,25 @@ DEFAULT_CONFIG = """\ ...@@ -37,33 +37,25 @@ DEFAULT_CONFIG = """\
class ServerNoticesConfig(Config): class ServerNoticesConfig(Config):
def __init__(self): """Configuration for the server notices room.
super(ServerNoticesConfig, self).__init__()
"""The MXID to use for server notices. Attributes:
server_notices_mxid (str|None):
The MXID to use for server notices.
None if server notices are not enabled.
None if server notices are not enabled. server_notices_mxid_display_name (str|None):
The display name to use for the server notices user.
None if server notices are not enabled.
type: str|None server_notices_room_name (str|None):
""" The name to use for the server notices room.
None if server notices are not enabled.
"""
def __init__(self):
super(ServerNoticesConfig, self).__init__()
self.server_notices_mxid = None self.server_notices_mxid = None
"""The display name to use for the server notices user.
None if server notices are not enabled.
type: str|None
"""
self.server_notices_mxid_display_name = None self.server_notices_mxid_display_name = None
"""The name to use for the server notices room.
None if server notices are not enabled.
(TODO: i18n)
type: str|None
"""
self.server_notices_room_name = None self.server_notices_room_name = None
def read_config(self, config): def read_config(self, config):
...@@ -78,7 +70,7 @@ class ServerNoticesConfig(Config): ...@@ -78,7 +70,7 @@ class ServerNoticesConfig(Config):
self.server_notices_mxid_display_name = c.get( self.server_notices_mxid_display_name = c.get(
'system_mxid_display_name', 'Server Notices', 'system_mxid_display_name', 'Server Notices',
) )
# todo: i18n
self.server_notices_room_name = c.get('room_name', "Server Notices") self.server_notices_room_name = c.get('room_name', "Server Notices")
def default_config(self, **kwargs): def default_config(self, **kwargs):
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment