summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2015-10-16 11:52:16 +0100
committerErik Johnston <erik@matrix.org>2015-10-16 11:52:16 +0100
commitb62da463e18a05205725f75508d5053232f1a158 (patch)
tree708fff0e74fe69b8aff5e570ca2a8439a87b8f98 /synapse
parentAdd docstring (diff)
downloadsynapse-b62da463e18a05205725f75508d5053232f1a158.tar.xz
docstring
Diffstat (limited to 'synapse')
-rw-r--r--synapse/handlers/search.py10
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", [