From b62da463e18a05205725f75508d5053232f1a158 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 16 Oct 2015 11:52:16 +0100
Subject: docstring

---
 synapse/handlers/search.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'synapse')

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", [
-- 
cgit 1.4.1