aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/core/result.py
diff options
context:
space:
mode:
Diffstat (limited to 'pygithub3/core/result.py')
-rw-r--r--pygithub3/core/result.py10
1 files changed, 8 insertions, 2 deletions
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