diff options
| author | Richard van der Hoff <richard@matrix.org> | 2018-05-18 11:00:55 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2018-05-18 11:00:55 +0100 |
| commit | d10707c8105f4cc7f079ed45960f8333c6101c86 (patch) | |
| tree | 90189b637ac2a56088eeaf327eb33ca6f2990c43 /synapse/config | |
| parent | fix missing yield for server_notices_room (diff) | |
| download | synapse-d10707c8105f4cc7f079ed45960f8333c6101c86.tar.xz | |
Replace inline docstrings with "Attributes" in class docstring
Diffstat (limited to 'synapse/config')
| -rw-r--r-- | synapse/config/server_notices_config.py | 38 |
1 files changed, 15 insertions, 23 deletions
diff --git a/synapse/config/server_notices_config.py b/synapse/config/server_notices_config.py index 51ddcac112..ccef8d2ec5 100644 --- a/synapse/config/server_notices_config.py +++ b/synapse/config/server_notices_config.py @@ -37,33 +37,25 @@ DEFAULT_CONFIG = """\ class ServerNoticesConfig(Config): - def __init__(self): - super(ServerNoticesConfig, self).__init__() + """Configuration for the server notices room. - """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 - - """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 - - """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 def read_config(self, config): @@ -78,7 +70,7 @@ class ServerNoticesConfig(Config): self.server_notices_mxid_display_name = c.get( 'system_mxid_display_name', 'Server Notices', ) - + # todo: i18n self.server_notices_room_name = c.get('room_name', "Server Notices") def default_config(self, **kwargs): |