summary refs log tree commit diff
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2022-03-10 09:40:07 -0800
committerGitHub <noreply@github.com>2022-03-10 09:40:07 -0800
commited9aea42fa991428406be96a67c311a8f9cec544 (patch)
treeeed4e332b87aab807dece07aa0db0fb72ba1c0a3
parentRemove workaround introduced in Synapse v1.50.0rc1 for Mjolnir compatibility.... (diff)
downloadsynapse-ed9aea42fa991428406be96a67c311a8f9cec544.tar.xz
fix misleading comment in `check_events_for_spam` (#12203)
-rw-r--r--changelog.d/12203.misc1
-rw-r--r--synapse/events/spamcheck.py4
2 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/12203.misc b/changelog.d/12203.misc
new file mode 100644
index 0000000000..892dc5bfb7
--- /dev/null
+++ b/changelog.d/12203.misc
@@ -0,0 +1 @@
+Fix a misleading comment in the function `check_event_for_spam`.
diff --git a/synapse/events/spamcheck.py b/synapse/events/spamcheck.py
index 04afd48274..60904a55f5 100644
--- a/synapse/events/spamcheck.py
+++ b/synapse/events/spamcheck.py
@@ -245,8 +245,8 @@ class SpamChecker:
         """Checks if a given event is considered "spammy" by this server.
 
         If the server considers an event spammy, then it will be rejected if
-        sent by a local user. If it is sent by a user on another server, then
-        users receive a blank event.
+        sent by a local user. If it is sent by a user on another server, the
+        event is soft-failed.
 
         Args:
             event: the event to be checked