From d5a26bd35820b1cb3de991fd45460345b9d3f492 Mon Sep 17 00:00:00 2001
From: David Medina <davidmedina9@gmail.com>
Date: Wed, 29 Feb 2012 01:22:16 +0100
Subject: Init documentation

+core
+services.user
~services.repos
---
 pygithub3/core/client.py |  6 ------
 pygithub3/core/result.py | 10 ++++++++--
 2 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'pygithub3/core')

diff --git a/pygithub3/core/client.py b/pygithub3/core/client.py
index a9e9ad4..ce6cf7c 100644
--- a/pygithub3/core/client.py
+++ b/pygithub3/core/client.py
@@ -15,12 +15,6 @@ class Client(object):
     """ Client to send configurated requests"""
 
     def __init__(self, **kwargs):
-        """
-        It can be configurated
-
-        :login, :password, :user, :repo, :token, :per_page, :base_url, :verbose
-        """
-
         self.requester = requests.session()
         self.config = {
             'per_page': 100,
diff --git a/pygithub3/core/result.py b/pygithub3/core/result.py
index 226d6ab..9e69e7d 100644
--- a/pygithub3/core/result.py
+++ b/pygithub3/core/result.py
@@ -135,10 +135,11 @@ class Page(object):
 
 
 class Result(object):
-    """ """
+    """
+    Result is a very lazy paginator. It only do a real request when is needed
+    """
 
     def __init__(self, client, request, **kwargs):
-        """ """
         self.getter = Method(client.get, request, **kwargs)
         self.page = Page(self.getter)
 
@@ -158,9 +159,14 @@ class Result(object):
 
     @property
     def pages(self):
+        """ Total number of pages in request """
         return self.getter.last
 
     def get_page(self, page):
+        """ Get ``Page`` of resources
+
+        :param int page: Page number
+        """
         if page in xrange(1, self.pages + 1):
             return Page(self.getter, page)
         return None
-- 
cgit v1.2.3-59-g8ed1b