1 files changed, 40 insertions, 11 deletions
diff --git a/github3/api.py b/github3/api.py
index d82bd3a..6c41e53 100644
--- a/github3/api.py
+++ b/github3/api.py
@@ -6,23 +6,34 @@
 import requests
 import json
 from errors import GithubError
-import github3.exceptions as ghexceptions
 
 RESOURCES_PER_PAGE = 100
 
 class GithubCore(object):
-    """ Wrapper for requests """
+    """
+    Wrapper to github api requests
+
+    Methods: get, head, post, patch, put, delete
+    """
 
     requests_remaining = None
     base_url = 'https://api.github.com/'
 
     def __init__(self):
+        """
+        Init `requests.session`
+        Init JSON parser
+        """
         self.session = requests.session()
         self.session.params = {'per_page': RESOURCES_PER_PAGE}
         self._parser = json
 
     def get(self, request, paginate=False, **kwargs):
-        print '\nGET %s %s\n' % (request, kwargs)
+        """
+        GET request
+
+        :param paginate: Boolean to return link header to paginate
+        """
         response = self._request('GET', request, **kwargs)
         content = self._parser.loads(response.content)
         if paginate:
@@ -31,37 +42,49 @@ class GithubCore(object):
             return content
 
     def head(self, request, **kwargs):
+        """ HEAD request """
         return self._request('HEAD', request, **kwargs).headers
 
     def post(self, request, data=None, **kwargs):
+        """
+        POST request
+
+        :param data: raw python object to send
+        """
         kwargs['data'] = self._parser.dumps(data)
         response = self._request('POST', request, **kwargs)
         assert response.status_code == 201
         return self._parser.loads(response.content)
 
     def patch(self, request, data=None, **kwargs):
+        """
+        PATCH request
+
+        :param data: raw python object to send
+        """
         kwargs['data'] = self._parser.dumps(data)
         response = self._request('PATCH', request, **kwargs)
         assert response.status_code == 200
         return self._parser.loads(response.content)
 
     def put(self, request, **kwargs):
+        """ PUT request """
         response = self._request('PUT', request, **kwargs)
         assert response.status_code == 204
 
-    def bool(self, request, **kwargs):
-        try:
-            response = self._request('GET', request, **kwargs)
-        except ghexceptions.NotFound:
-            return False
-        assert response.status_code == 204
-        return True
-
     def delete(self, request, **kwargs):
+        """ DELETE request """
         response = self._request('DELETE', request, **kwargs)
         assert response.status_code == 204
 
     def _parse_args(self, request_args):
+        """
+        Arg's parser to `_request` method
+
+        It check keyword args to parse extra request args to params
+        Sample:
+            _parse_args(arg1=1, arg2=2) => params = {'arg1': 1, 'arg2': 2}
+        """
         request_core = (
             'params','data','headers','cookies','files','auth','tiemout',
             'allow_redirects','proxies','return_response','config')
@@ -79,7 +102,13 @@ class GithubCore(object):
         return request_args
 
     def _request(self, verb, request, **kwargs):
+        """
+        Http request wrapper
 
+        :param verb: Http method
+        :param request : Url query request
+        :param kwargs: Keyword args to request
+        """
         request = self.base_url + request
         parsed_args = self._parse_args(kwargs)
         response = self.session.request(verb, request, **parsed_args)