summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorRichard van der Hoff <github@rvanderhoff.org.uk>2018-03-15 11:05:42 +0000
committerGitHub <noreply@github.com>2018-03-15 11:05:42 +0000
commit0ad5125814dc18a79423740ac54f96e16a427758 (patch)
treea6b05b12c0f7f29205c2c02ff99d7f83e45dd165 /docs/admin_api
parentCHANGES.rst: reword metric deprecation (diff)
downloadsynapse-0ad5125814dc18a79423740ac54f96e16a427758.tar.xz
Update purge_history_api.rst
clarify that `purge_history` will not purge state
Diffstat (limited to 'docs/admin_api')
-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