docstring

1 files changed, 10 insertions, 0 deletions

diff --git a/synapse/handlers/search.py b/synapse/handlers/search.py
index 7f1efe2b46..c01c12f8c1 100644
--- a/synapse/handlers/search.py
+++ b/synapse/handlers/search.py
@@ -82,6 +82,16 @@ class SearchHandler(BaseHandler):
 
     @defer.inlineCallbacks
     def search(self, user, content):
+        """Performs a full text search for a user.
+
+        Args:
+            user (UserID)
+            content (dict): Search parameters
+
+        Returns:
+            dict to be returned to the client with results of search
+        """
+
         try:
             search_term = content["search_categories"]["room_events"]["search_term"]
             keys = content["search_categories"]["room_events"].get("keys", [