summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erikj@jki.re>2018-03-15 13:31:54 +0000
committerGitHub <noreply@github.com>2018-03-15 13:31:54 +0000
commit873aea716895ea6a10af406153be67a613a50a38 (patch)
treeba41a435b228b710ba5a1f98052983a60b07bb18
parentMerge pull request #2997 from turt2live/patch-2 (diff)
parentUpdate purge_history_api.rst (diff)
downloadsynapse-873aea716895ea6a10af406153be67a613a50a38.tar.xz
Merge pull request #3002 from matrix-org/rav/purge_doc
Update purge_history_api.rst
-rw-r--r--docs/admin_api/purge_history_api.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/admin_api/purge_history_api.rst b/docs/admin_api/purge_history_api.rst
index ea2922da5c..2da833c827 100644
--- a/docs/admin_api/purge_history_api.rst
+++ b/docs/admin_api/purge_history_api.rst
@@ -16,9 +16,11 @@ including an ``access_token`` of a server admin.
 
 By default, events sent by local users are not deleted, as they may represent
 the only copies of this content in existence. (Events sent by remote users are
-deleted, and room state data before the cutoff is always removed).
+deleted.)
 
-To delete local events as well, set ``delete_local_events`` in the body:
+Room state data (such as joins, leaves, topic) is always preserved.
+
+To delete local message events as well, set ``delete_local_events`` in the body:
 
 .. code:: json