Update the documentation of the filtering function

2019-12-16 12:15:37 +00:00 · 2019-12-16 12:15:37 +00:00 · ac87ddb242
parent 487f1bb49d
commit ac87ddb242
1 changed files with 2 additions and 1 deletions
--- a/synapse/visibility.py
+++ b/synapse/visibility.py
@ -52,7 +52,8 @@ def filter_events_for_client(
    apply_retention_policies=True,
 ):
    """
-    Check which events a user is allowed to see
+    Check which events a user is allowed to see. If the user can see the event but its
+    sender asked for their data to be erased, prune the content of the event.

    Args:
        storage