diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2022-11-16 10:25:24 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-16 15:25:24 +0000 |
| commit | d8cc86eff484b6f570f55a5badb337080c6e4dcd (patch) | |
| tree | 3db789870dcd3cadda373b33c0aa0bfa1ca33ffb /synapse/server_notices | |
| parent | Fix background updates failing to add unique indexes on receipts (#14453) (diff) | |
| download | synapse-d8cc86eff484b6f570f55a5badb337080c6e4dcd.tar.xz | |
Remove redundant types from comments. (#14412)
Remove type hints from comments which have been added as Python type hints. This helps avoid drift between comments and reality, as well as removing redundant information. Also adds some missing type hints which were simple to fill in.
Diffstat (limited to 'synapse/server_notices')
| -rw-r--r-- | synapse/server_notices/consent_server_notices.py | 5 | ||||
| -rw-r--r-- | synapse/server_notices/resource_limits_server_notices.py | 12 |
2 files changed, 9 insertions, 8 deletions
diff --git a/synapse/server_notices/consent_server_notices.py b/synapse/server_notices/consent_server_notices.py index 698ca742ed..94025ba41f 100644 --- a/synapse/server_notices/consent_server_notices.py +++ b/synapse/server_notices/consent_server_notices.py @@ -113,9 +113,8 @@ def copy_with_str_subst(x: Any, substitutions: Any) -> Any: """Deep-copy a structure, carrying out string substitutions on any strings Args: - x (object): structure to be copied - substitutions (object): substitutions to be made - passed into the - string '%' operator + x: structure to be copied + substitutions: substitutions to be made - passed into the string '%' operator Returns: copy of x diff --git a/synapse/server_notices/resource_limits_server_notices.py b/synapse/server_notices/resource_limits_server_notices.py index 3134cd2d3d..a31a2c99a7 100644 --- a/synapse/server_notices/resource_limits_server_notices.py +++ b/synapse/server_notices/resource_limits_server_notices.py @@ -170,11 +170,13 @@ class ResourceLimitsServerNotices: room_id: The room id of the server notices room Returns: - bool: Is the room currently blocked - list: The list of pinned event IDs that are unrelated to limit blocking - This list can be used as a convenience in the case where the block - is to be lifted and the remaining pinned event references need to be - preserved + Tuple of: + Is the room currently blocked + + The list of pinned event IDs that are unrelated to limit blocking + This list can be used as a convenience in the case where the block + is to be lifted and the remaining pinned event references need to be + preserved """ currently_blocked = False pinned_state_event = None |