From ed9aea42fa991428406be96a67c311a8f9cec544 Mon Sep 17 00:00:00 2001
From: Shay <hillerys@element.io>
Date: Thu, 10 Mar 2022 09:40:07 -0800
Subject: [PATCH] fix misleading comment in `check_events_for_spam` (#12203)
---
changelog.d/12203.misc | 1 +
synapse/events/spamcheck.py | 4 ++--
2 files changed, 3 insertions(+), 2 deletions(-)
create mode 100644 changelog.d/12203.misc
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
--
GitLab