From a7648696231f3df7ec1f324a15dc308fbee2a985 Mon Sep 17 00:00:00 2001
From: David Teller <d.o.teller+github@gmail.com>
Date: Thu, 28 Jan 2021 12:19:39 +0100
Subject: FIXUP: Doc

---
 synapse/rest/admin/rooms.py | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'synapse/rest/admin/rooms.py')

diff --git a/synapse/rest/admin/rooms.py b/synapse/rest/admin/rooms.py
index 4393197549..50df60e029 100644
--- a/synapse/rest/admin/rooms.py
+++ b/synapse/rest/admin/rooms.py
@@ -568,6 +568,12 @@ class ForwardExtremitiesRestServlet(RestServlet):
         return 200, {"count": len(extremities), "results": extremities}
 
 class RoomEventContextServlet(RestServlet):
+    """
+    Provide the context for an event.
+    This API is designed to be used when system administrators wish to look at
+    an abuse report and understand what happened during and immediately prior
+    to this event.
+    """
     PATTERNS = admin_patterns("/rooms/(?P<room_id>[^/]*)/context/(?P<event_id>[^/]*)$")
 
     def __init__(self, hs):
-- 
cgit 1.4.1