fix misleading comment in check_events_for_spam (#12203)

matrix-org · Mar 10, 2022 · ed9aea4 · ed9aea4
1 parent 72e7f1c
commit ed9aea4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/changelog.d/12203.misc 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
@@ -245,8 +245,8 @@ async def check_event_for_spam(
         """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