Add docstring for parametized attributes

See https://github.com/element-hq/synapse/pull/17167#discussion_r1611301044
This commit is contained in:
Eric Eastwood 2024-05-23 09:23:02 -05:00
parent d4b41aaf43
commit 6606ac1d07
2 changed files with 25 additions and 3 deletions

View file

@ -46,6 +46,10 @@ from tests.unittest import HomeserverTestCase, override_config
class SendToDeviceTestCase(HomeserverTestCase):
"""
Test `/sendToDevice` will deliver messages across to people receiving them over `/sync`.
Attributes:
sync_endpoint (str): The endpoint under test to use for syncing.
experimental_features (JsonDict): The experimental features homeserver config to use.
"""
servlets = [

View file

@ -700,7 +700,13 @@ class SyncCacheTestCase(unittest.HomeserverTestCase):
],
)
class DeviceListSyncTestCase(unittest.HomeserverTestCase):
"""Tests regarding device list (`device_lists`) changes."""
"""
Tests regarding device list (`device_lists`) changes.
Attributes:
sync_endpoint (str): The endpoint under test to use for syncing.
experimental_features (JsonDict): The experimental features homeserver config to use.
"""
servlets = [
synapse.rest.admin.register_servlets,
@ -907,7 +913,13 @@ class DeviceListSyncTestCase(unittest.HomeserverTestCase):
],
)
class DeviceOneTimeKeysSyncTestCase(unittest.HomeserverTestCase):
"""Tests regarding device one time keys (`device_one_time_keys_count`) changes."""
"""
Tests regarding device one time keys (`device_one_time_keys_count`) changes.
Attributes:
sync_endpoint (str): The endpoint under test to use for syncing.
experimental_features (JsonDict): The experimental features homeserver config to use.
"""
servlets = [
synapse.rest.admin.register_servlets,
@ -1013,7 +1025,13 @@ class DeviceOneTimeKeysSyncTestCase(unittest.HomeserverTestCase):
],
)
class DeviceUnusedFallbackKeySyncTestCase(unittest.HomeserverTestCase):
"""Tests regarding device one time keys (`device_unused_fallback_key_types`) changes."""
"""
Tests regarding device one time keys (`device_unused_fallback_key_types`) changes.
Attributes:
sync_endpoint (str): The endpoint under test to use for syncing.
experimental_features (JsonDict): The experimental features homeserver config to use.
"""
servlets = [
synapse.rest.admin.register_servlets,