fix misleading comment in check_events_for_spam (#12203)

This commit is contained in:
Shay 2022-03-10 09:40:07 -08:00 committed by GitHub
parent 72e7f1c420
commit ed9aea42fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions

1
changelog.d/12203.misc Normal file
View file

@ -0,0 +1 @@
Fix a misleading comment in the function `check_event_for_spam`.

View file

@ -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