summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2019-12-16 12:15:37 +0000
committerBrendan Abolivier <babolivier@matrix.org>2019-12-16 12:15:37 +0000
commitac87ddb242d146cd840b232fa6e8165c9dd01ae6 (patch)
tree95033c5ac738b9852de65967edb7936285978935 /synapse
parentUse the filtered version of an event when responding to /context requests for... (diff)
downloadsynapse-ac87ddb242d146cd840b232fa6e8165c9dd01ae6.tar.xz
Update the documentation of the filtering function
Diffstat (limited to 'synapse')
-rw-r--r--synapse/visibility.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/synapse/visibility.py b/synapse/visibility.py
index dffe943b28..100dc47a8a 100644
--- 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