aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-03-04 16:58:08 +0100
committerDavid Medina <davidmedina9@gmail.com>2012-03-04 17:18:06 +0100
commit14ef05b1ffef24fae97ae3e79567ab612a75ff11 (patch)
tree9397c561b8b963d9b65dbda1f496f01a0f2d3ab2 /docs
parentWrap result getter into partial. It's cleaner (diff)
downloadpython-github3-14ef05b1ffef24fae97ae3e79567ab612a75ff11.tar.xz
python-github3-14ef05b1ffef24fae97ae3e79567ab612a75ff11.zip
Refactor result. Now it's a package
result.smart => Paginate iterator with 'page' behaviour. result.normal => Paginate iterator with 'next' behaviour.
Diffstat (limited to 'docs')
-rw-r--r--docs/result.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/result.rst b/docs/result.rst
index f084807..182ed5c 100644
--- a/docs/result.rst
+++ b/docs/result.rst
@@ -5,5 +5,14 @@ Result
Some requests returns multiple :doc:`resources`, for that reason the
``Github API`` paginate it and **pygithub3** too
-.. autoclass:: pygithub3.core.result.Result
+Smart Result
+--------------
+
+.. autoclass:: pygithub3.core.result.smart.Result
+ :members:
+
+Normal Result
+---------------
+
+.. autoclass:: pygithub3.core.result.normal.Result