From 334a286c18652423447aff589ec0f25406e4d8ea Mon Sep 17 00:00:00 2001
From: Thomas Pointhuber <thomas.pointhuber@gmx.at>
Date: Tue, 2 Sep 2014 17:37:47 +0200
Subject: [PATCH] update github engine and add comments

---
 searx/engines/github.py | 32 ++++++++++++++++++++++++++++++--
 searx/settings.yml      |  1 -
 2 files changed, 30 insertions(+), 3 deletions(-)

diff --git a/searx/engines/github.py b/searx/engines/github.py
index d36797aba..53fec029f 100644
--- a/searx/engines/github.py
+++ b/searx/engines/github.py
@@ -1,31 +1,59 @@
+## Github (It)
+# 
+# @website     https://github.com/
+# @provide-api yes (https://developer.github.com/v3/)
+# 
+# @using-api   yes
+# @results     JSON
+# @stable      yes (using api)
+# @parse       url, title, content
+
 from urllib import urlencode
 from json import loads
 from cgi import escape
 
+# engine dependent config
 categories = ['it']
 
+# search-url
 search_url = 'https://api.github.com/search/repositories?sort=stars&order=desc&{query}'  # noqa
 
 accept_header = 'application/vnd.github.preview.text-match+json'
 
 
+# do search-request
 def request(query, params):
     params['url'] = search_url.format(query=urlencode({'q': query}))
+
     params['headers']['Accept'] = accept_header
+
     return params
 
 
+# get response from search-request
 def response(resp):
     results = []
+
     search_res = loads(resp.text)
+
+    # check if items are recieved
     if not 'items' in search_res:
-        return results
+        return []
+
+    # parse results
     for res in search_res['items']:
         title = res['name']
         url = res['html_url']
+
         if res['description']:
             content = escape(res['description'][:500])
         else:
             content = ''
-        results.append({'url': url, 'title': title, 'content': content})
+
+        # append result
+        results.append({'url': url,
+                        'title': title,
+                        'content': content})
+
+    # return results
     return results
diff --git a/searx/settings.yml b/searx/settings.yml
index c6227212e..1d5f36a57 100644
--- a/searx/settings.yml
+++ b/searx/settings.yml
@@ -66,7 +66,6 @@ engines:
 
   - name : github
     engine : github
-    categories : it
     shortcut : gh
 
   - name : google