From d7d8f153a31b76493daf68a44e01d4c4e11b180d Mon Sep 17 00:00:00 2001
From: Lorenz Diener <lorenz.diener@uni-bremen.de>
Date: Wed, 13 Dec 2017 17:55:14 +0100
Subject: Update docs for search function

---
 docs/index.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'docs')

diff --git a/docs/index.rst b/docs/index.rst
index fe92636..da670b1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -340,6 +340,18 @@ Card dicts
         'provider_url': # URL pointing to the embeds provider
     }
 
+Search result dicts
+~~~~~~~~~~~~~~~~~~~
+.. code-block:: python
+
+    mastodon.search(...)
+    # Returns the folowing dictionary
+    {
+        'accounts': # List of account dicts resulting from the query
+        'hashtags': # List of hashtag dicts resulting from the query
+        'statuses': # List of toot dicts resulting from the query
+    }    
+    
 Instance dicts
 ~~~~~~~~~~~~~~
 .. code-block:: python
-- 
cgit v1.2.3