OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Replace inline docstrings with "Attributes" in class docstring

pull/3232/head
Richard van der Hoff 2018-05-18 11:00:55 +01:00
parent 88d3405332
commit d10707c810
1 changed files with 16 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
synapse/config/server_notices_config.py
View File

@ -37,33 +37,25 @@ DEFAULT_CONFIG = """\
class ServerNoticesConfig(Config): class ServerNoticesConfig(Config):
"""Configuration for the server notices room.
Attributes:
server_notices_mxid (str|None):
The MXID to use for server notices.
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.
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): def __init__(self):
super(ServerNoticesConfig, self).__init__() super(ServerNoticesConfig, self).__init__()
"""The MXID to use for server notices.
None if server notices are not enabled.
type: str|None
"""
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):
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):