From 86bf08cbd4ffa3234c87de95e613f028e8fbcddf Mon Sep 17 00:00:00 2001
From: Ruud <ruud@crashdummy.nl>
Date: Wed, 26 Sep 2012 21:01:48 +0200
Subject: [PATCH] Add documentation to progress api

---
 couchpotato/core/plugins/searcher/main.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/couchpotato/core/plugins/searcher/main.py b/couchpotato/core/plugins/searcher/main.py
index 76ee24d8..f165f6a9 100644
--- a/couchpotato/core/plugins/searcher/main.py
+++ b/couchpotato/core/plugins/searcher/main.py
@@ -42,6 +42,9 @@ class Searcher(Plugin):
 
         addApiView('searcher.progress', self.getProgress, docs = {
             'desc': 'Get the progress of current full search',
+            'return': {'type': 'object', 'example': """{
+    'progress': False || object, total & to_go,
+}"""},
         })
 
         # Schedule cronjob